Skip to main content

Access

The source data endpoints, GET /indices/{name}/history/sources and GET /indices/{name}/history/export, are available to members of institutions approved for Index Explorer source data. The other endpoints are public and need no key.
  • Create a key on Index Explorer. The secret is shown once, so store it securely.
  • Approval is checked on every request. If your institution’s approval ends, its keys stop working within about a minute.
  • Each account can make 300 requests per minute to these endpoints by default. A 429 response includes a Retry-After header.

Signing Requests

Send three headers with every request: The prehash is the timestamp, the uppercase HTTP method, the request path and the body, joined with no separator:
  • The path includes /v1 and excludes the query string.
  • The body is empty for GET requests.
  • The timestamp must be within 30 seconds of our server’s time. GET https://api.forum.market/v1/time returns it.
  • Use the secret string as the HMAC key as is. Do not base64-decode it.

Example

Errors