HTTP Methods

API Calls

List all jobs

Retrieves the list of backfilling jobs.

GEThttps://api.dh3.io/backfill/job/

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "44",
    "name": "scan-1",
    "status": "COMPLETED",
    "batch": "1",
    "hooks": {
      "data": "https://my.project.com/callback",
      "status": null,
      "metrics": null
    },
    "cpu_limit": "1",
    "range": {
      "blocks": {
        "start": 164776968,
        "end": 164754296
      },
      "time": {
        "start": 1670110514,
        "end": 1670120614
      }
    },
    "filter": [
      {
        "include": {
          "instructions": [
            {
              "address": "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s",
              "discriminator": "10",
              "discriminatorType": "u8"
            }
          ]
        }
      }
    ],
    "metrics": {
      "cpu_time": 220,
      "run_time": 220,
      "txt_forward": 1313,
      "txt_per_sec": 4279,
      "txt_scanned": 941482,
      "callback_error_count": 0,
      "completed_percentage": 100,
      "callback_success_count": 137,
      "callback_bytes_transmit": 0
    }
  }
]

Create Job

Creates a backfilling task that retrieves transactions based on specified filters and subsequently submits them to a predefined URL in the hook's data field.

POSThttps://api.dh3.io/backfill/job/

Query parameters

Body

application/json

name*string

The name of job.

range*object

Range to scan, block id's or timestamps can be used

filter*object

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Response

200

Successful response

Body

application/json

idinteger

After success job creation, it will return it's ID.

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "scan-1",
      "hooks": {
        "data": "https://my.project.com/callback/"
      },
      "range": {
        "time": {
          "start": 1670110514,
          "end": 1670120614
        }
      },
      "filter": [
        {
          "name": "metaplex-CreateMetadataV2",
          "include": {
            "instructions": [
              {
                "address": "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s",
                "discriminator": "10",
                "discriminatorType": "u8"
              }
            ]
          }
        }
      ],
      "parser": {
        "enabled": [
          "data"
        ]
      },
      "cpu_limit": 1,
      "batch": 10
    }),
});
const data = await response.json();

Response

200

{
  "id": 1
}

Get a job

Retrieves full job information

GEThttps://api.dh3.io/backfill/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "44",
  "name": "scan-1",
  "status": "COMPLETED",
  "batch": "1",
  "hooks": {
    "data": "https://my.project.com/callback",
    "status": null,
    "metrics": null
  },
  "cpu_limit": "1",
  "range": {
    "blocks": {
      "start": 164776968,
      "end": 164754296
    },
    "time": {
      "start": 1670110514,
      "end": 1670120614
    }
  },
  "filter": [
    {
      "include": {
        "instructions": [
          {
            "address": "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s",
            "discriminator": "10",
            "discriminatorType": "u8"
          }
        ]
      }
    }
  ],
  "metrics": {
    "cpu_time": 220,
    "run_time": 220,
    "txt_forward": 1313,
    "txt_per_sec": 4279,
    "txt_scanned": 941482,
    "callback_error_count": 0,
    "completed_percentage": 100,
    "callback_success_count": 137,
    "callback_bytes_transmit": 0
  }
}

Delete job

Delete backfilling job.

DELETEhttps://api.dh3.io/backfill/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "ok"
}

Update job

Updates job params.

PATCHhttps://api.dh3.io/backfill/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "ok"
}

Start job

Starts a backfilling process. If the time range is big, it could take up to a few minutes to start.

PATCHhttps://api.dh3.io/backfill/job/{id}/start

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}/start', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "ok"
}

Stop job

Stops backfilling process. After that job will have PAUSE status.

PATCHhttps://api.dh3.io/backfill/job/{id}/stop

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

namestring

The name of job.

rangeobject

Range to scan, block id's or timestamps can be used

filterobject

An array of filters to apply. Check the Transaction Filter for details.

hooksobject

parserobject

batchinteger

Batch webhook calls. Specify the number of transactions to be batched in one call. Defaults to 1

cpu_limitinteger

Limit CPU for JOB, one CPU does ~20 000 transaction rescans. Speed can vary based on how many records are picked up and sent back. You can look at it as concurrency or threads, one CPU will always send one hook at the moment. Defaults to 1

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}/stop', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

200

{
  "message": "ok"
}

Get a job metrics

Metrics can be received on demand via this call or by getting full job information. Also you can defined metrics web hook callback when creating job.

GEThttps://api.dh3.io/backfill/job/{id}/metrics

Path parameters

idinteger

Example: 44

Query parameters

Body

Response

200

Successful response

Body

application/json

cpu_timeinteger

Run time in seconds of all CPU cores assigned

run_timeinteger

A Job run time in seconds.

Request

JavaScriptCurlPython

const response = await fetch('https://api.dh3.io/backfill/job/{id}/metrics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "cpu_time": 220,
  "run_time": 220,
  "txt_forward": 1313,
  "txt_per_sec": 4279,
  "txt_scanned": 941482,
  "callback_error_count": 0,
  "completed_percentage": 100,
  "callback_success_count": 137,
  "callback_bytes_transmit": 0
}