Settings

Get a data export

One export's status. Owner session only; reachable while the account is locked.

get/api/v1/me/export/{jobId}

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/me/export/{jobId}
  • Auth: API key in cookie auth_token

Path parameters

jobIdstring required

The export id

Response

The export

idstring required
status'preparing' | 'ready' | 'failed' required

preparing while the job runs; ready once the file can be downloaded; failed with error

error'too_large' | 'internal' | 'null' nullable required

too_large — more than one download can carry (no partial file is ever produced; contact support); internal — a failure on our side (start a new export at once, the daily limit was given back)

requested_atstring date-time required
ready_atstring date-time nullable required
expires_atstring date-time required

The export and its file are deleted at this time — 7 days after the request

downloaded_atstring date-time nullable required

The first download, if any

size_bytesinteger nullable required

Size of the compressed file as stored

countsobject required

Rows per section of the file

download_pathstring nullable required

Path of the download route while ready, else null

Changes

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