Skip to main content

Your first request

Use the public base URL below and obtain a token through Authentication. Run these examples in your own terminal. This documentation is read-only: it does not accept credentials or submit API requests.

Public base URL: https://{{API_HOST}}.

To follow this walkthrough in Postman or Bruno, use Try the API to import the contract and configure authentication. Open Get current market status and use the request URL below with your BASE_URL variable. The expected response is described in step 2.

{{BASE_URL}}/v1/market/status

Each endpoint also has generated examples in several languages. Replace {{ACCESS_TOKEN}} with your token and resource placeholders with identifiers from discovery. The cURL walkthrough below stores the full HTTPS base URL in a shell environment variable.

1. Prepare your environment​

Replace <ACCESS_TOKEN> with a current token from Get an access token.

BASE_URL='https://{{API_HOST}}'
ACCESS_TOKEN='<ACCESS_TOKEN>'

Keep real tokens out of shared scripts, terminal history, source control and logs. Use your approved secret-handling process when supplying ACCESS_TOKEN in a real environment.

2. Read market status​

curl --request GET \
  --url "${BASE_URL%/}/v1/market/status" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header 'Accept: application/json' \
  --header 'X-Correlation-Id: first-market-status-check' \
  --include

The successful HTTP status is 200. The JSON response contains status, changedAt and observedAt:

{
  "status": "OPEN",
  "changedAt": "2026-09-03T10:11:12.123456Z",
  "observedAt": "2026-09-03T10:12:13.654321Z"
}

The example illustrates the shape; the current market state and timestamps will differ. Keep the response's X-Request-Id when contacting support. Your valid X-Correlation-Id is echoed for your own tracing.

For 401 authentication-failed, obtain a valid token through Authentication. For other failures, use the problem catalogue.

3. Discover your Accounts​

curl --request GET \
  --url "${BASE_URL%/}/v1/accounts?limit=50" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header 'Accept: application/json'

Read the returned items and select an Account by its stable CCV. An empty list can be a successful result. See Accounts for permissions, Pagination to continue through results, or Market Instruments to discover Instruments.