Exports

Export status

Read an export job.

GET/v1/exports/{id}exportsGet

On this page

Example request
Parameters
Response

Example request

curl -sS "https://api.ordermap.si/v1/exports/$EXPORT_ID" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY"

const id = "EXPORT_ID";
const res = await fetch(`https://api.ordermap.si/v1/exports/${id}`, {
  headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);

Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.

Parameters

1 parameter, 1 required.

Parameter	Type and limits	Description
`id`pathrequired	stringat most 64 characters	Export id returned when the export was created.

Response

Status	Meaning	Body
`200`	The export and its state.	Schema below
`401`	Missing or invalid API key.	Error object
`404`	No such export for this account.	Error object
`429`	Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After	Error object

Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.

200 response body

dataobjectrequiredAn export job.16 fields inside
- bytesintegerFile size once ready.
- created_timestampintegerunix-msrequiredWhen the job was accepted. Unix epoch milliseconds (UTC).
- download_urlstringRelative URL of the file once ready.
- error_codestringFailure code when the job failed.
- failed_timestampintegerunix-msWhen the job failed for good, once it has. Unix epoch milliseconds (UTC).
- failure_reasonstringFailure description when the job failed.
- idstringrequiredExport id.
- last_attempt_timestampintegerunix-msWhen the job last ran and did not finish, once it has. Unix epoch milliseconds (UTC).
- pagesintegerPages of the endpoint the export read once ready.
- pathstringrequiredEndpoint path.
- querymap<string>requiredThe query as requested: one string per parameter (numbers and booleans as text, a list as a comma-separated string).
- resolutionstringSummary of what the file holds once ready.
- revisionintegerrequiredIncreases with every state change.
- rowsintegerRows in the file once ready.
- statusstringrequiredJob state.queuedretryingawaiting_configurationfailedready
- truncatedbooleanThe data was cut at the row, size or page limit once ready.
metaobjectrequired1 fields inside
- request_idstringrequiredIdentifier of this request, for support.