Batches

Get a batch's status, summaries and results

Polling costs no requests but counts toward the per-minute rate limit.

get/batches/{id}

Request

  • Base URL: https://api.soldgraph.com/v1
  • URL: https://api.soldgraph.com/v1/batches/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

waitinteger

Seconds to hold the request open until every search settles (long-poll).

include'results'

Send results to include each search's full result.

format'json' | 'csv'

csv returns every row of every complete search as one file, once nothing is pending.

Response

The batch.

batch_idstring uuid required
status'pending' | 'complete' required

complete once no search is pending.

created_atstring date-time required
creditsinteger required

Requests this batch has cost so far.

Changes

No recorded changes to this operation across all 1 revision of this API.