HTTP Methods

API Calls

List all jobs

Retrieves the list of backfilling jobs.

get

/job/

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dh3.io/backfill/job/'

200

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
    }
  }
]

Successful response

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.

post

/job/

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

namestringrequired

The name of job.

rangeobjectrequired

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

filterobjectrequired

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

hooksobject

parserobject

batchinteger · min: 1 · max: 500

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

cpu_limitinteger · min: 1 · max: 20

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.dh3.io/backfill/job/' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
  }'

200

200

{
  "id": 1
}

Successful response

Get a job

Retrieves full job information

get

/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dh3.io/backfill/job/{id}'

200

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
  }
}

Successful response

Delete job

Delete backfilling job.

delete

/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.dh3.io/backfill/job/{id}'

200

200

{
  "message": "ok"
}

Successful response

Update job

Updates job params.

patch

/job/{id}

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dh3.io/backfill/job/{id}'

200

200

{
  "message": "ok"
}

Successful response

Start job

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

patch

/job/{id}/start

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dh3.io/backfill/job/{id}/start'

200

200

{
  "message": "ok"
}

Successful response

Stop job

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

patch

/job/{id}/stop

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.dh3.io/backfill/job/{id}/stop'

200

200

{
  "message": "ok"
}

Successful response

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.

get

/job/{id}/metrics

Path parameters

idinteger

Example: 44

Query parameters

tokenstring

Example: f469559d4cc55170a26031a4a5123eb2

Body

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.dh3.io/backfill/job/{id}/metrics'

200

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
}

Successful response