Skip to main content

Static Data API Overview

The BPX Static Data REST API can be used for accessing static data for the BPX MTF. The API provides access to instrument, market, holiday calendar and tick table information related to the BPX markets.

The authentication mechanism provided by the REST API can also be used to retrieve and manage an authentication token that can be used by for the BPX WebSocket API.

Supporting Documents​

Technical Connectivity​

The following details will be provided during technical onboarding per test and production technical connection to be setup:

  • API client_id
  • API client_secret

For connection availability please see the BPX market services documentation.

Authentication​

The BPX REST API uses a bearer authentication scheme. This token can be obtained by using the BPX REST API authentication paths and requires to be refreshed within a specified period of time. The refresh time period will be provided on the BPX MTF authorisation response.

Common Headers​

The full definition of the request and response header information is shared in the BPX OpenAPI specification.

Request Headers

{
  "Content-Type": "application/json"
  "Authorization": "Bearer <auth_token>"
  "Accept": "application/json"
}

Response Headers

{
  Content-Type: "application/json"
  "X-Trade-ID": "<request_trace_id>"
  "X-RateLimit-Limit": "<requests_per_minute>"
  "X-RateLimit-Remaining": "<remaining_requests>"
  "X-RateLimit-Reset": "<unix_timestamp>"
}

Rate Limiting​

The default limit is 100 requests per minute. Custom rate limits can be discussed with BPX during onboarding if required.

API Paths​

The full definition of the supported paths is shared in the BPX Static Data OpenAPI specification. The paths have been grouped by the following functionalities or resources:

  • Authentication – Used for retrieving a JWT for using either the REST or WebSocket APIs.
  • Instruments – Provides information on instruments open for primary market issuance auction bids or admitted to the BPX trading markets.
  • Markets – Provides information on the BPX primary or trading.
  • Calendars – Holiday calendars that are linked to BPX markets.
  • Tick Tables – Tick tables that are linked to BPX tradable instruments.