Fetching Batches

Fetching Batches

cURL

curl --request GET \
  --url https://waitlist-api.prod.blast.io/v1/contracts/{contractAddress}/batches \
  --header 'Authorization: <authorization>'

200

{
  "success": true,
  "batch": [
    {
      "id": "<string>",
      "contractAddress": "<string>",
      "pointType": {},
      "createdAt": "<string>",
      "finalizeAt": "<string>",
      "updatedAt": "<string>",
      "status": {},
      "points": "<string>",
      "transferCount": 123
    }
  ],
  "cursor": {}
}

You can inspect the overall status of your transfer batches using this paginated API.

Paging

Use the same query parameters as in the previous request, but add a cursor query parameter (with the cursor from the previous response).

If the cursor is null, there is nothing left to page.

Authentication

Authorization · string · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Params

contractAddress · string · required

Contract address which submitted the batches.

Query Params (Optional)

pointType · PointType

pointType can be PHASE2_POINTS or PHASE2_GOLD

status · Status

Status of the batch. Can be PENDING or CANCELLED or FINALIZING or FINALIZED.

createdBefore · string

For querying batches created before createdBefore timestamp (ISO8601)

createdAfter · string

For querying batches created after createdAfter timestamp (ISO8601)

sort · string

Sort by ASC or DESC creation order

Response

success · boolean

Response status.

batch · Batch[]

Batch details along with transfer details.

Show child attributes

id · string

Batch ID.

contractAddress · string

Contract address that requested the transfer of points.

pointType · PointType

Point type requested to be transferred. Can be PHASE2_POINTS or PHASE2_GOLD.

createdAt · string

Timestamp when the batch was created.

finalizeAt · string

Timestamp when the batch was finalized.

updatedAt · string

Timestamp when the batch was updated. If not updated then it will null.

status · Status

Status of the batch. Can be PENDING or CANCELLED or FINALIZING or FINALIZED.

points · string

Total points being transferred in the batch.

transferCount · number

Number of transfer that are part of the batch.

cursor · string | null

Cursor for pagination, if it is null there are no results left to paginate.