Skip to main content
GET
Export full history

Authorizations

FORUM-ACCESS-KEY
string
header
required

Your API key ID, starting with fk_.

FORUM-ACCESS-TIMESTAMP
string
header
required

The current Unix time in seconds. Must be within 30 seconds of the server's time.

FORUM-ACCESS-SIGN
string
header
required

Base64-encoded HMAC-SHA256 of the timestamp, method, path and body, keyed with your API secret. See Authentication.

Path Parameters

name
string
required

The index name, which is the index’s ticker followed by -IDX. GET /indices returns every name.

Query Parameters

afterId
integer
default:0

Return values with an id greater than this. Use 0 for the first page, then the previous page's nextAfterId.

Required range: x >= 0
throughId
integer

Return values with an id up to and including this. Omit on the first page, then pass the throughId it returned.

Required range: x >= 0

Response

A page of index values, ordered by id.

history
object[]
required

Up to 2,500 values, ordered by id.

throughId
integer
required

The last id this export covers. Pass it back with every following page.

Example:

512840

nextAfterId
integer | null
required

The afterId for the next page, or null when this is the last page.

Example:

505595