developers:websocket:markets

This is an old revision of the document!


Market Data and Definitions

The Market Data API provides access to all tradable instruments and their associated definitions within the platform. This REST-based API allows you to explore available markets, retrieve instrument specifications, and access critical trading parameters.

Unlike the real-time trading functionality which utilizes WebSocket and Protocol Buffers, the Market Data API follows REST principles for straightforward data retrieval and exploration. This documentation covers how to authenticate to the API and provides an overview of the available endpoints.

The Market Data API supports two authentication methods, depending on your integration scenario:

  • AuthKey Authentication: Designed for business-to-business (B2B) integrations, providing a simplified authentication mechanism for server-to-server communication.
  • JWT Authentication: Utilized for client-to-business (C2B) scenarios, offering secure token-based authentication for end-user applications.

To obtain a JWT token:

  1. Send a JWT request Protocol Buffer message to the authentication endpoint
  2. The server will respond with a JWT token that should be included in subsequent API requests
  3. Include the JWT token in the Authorization header using the Bearer scheme

For B2B integrations:

  1. Use your provided AuthKey for direct API access
  2. Include the AuthKey in the request header as specified in the API documentation
  3. AuthKeys have configurable permissions and can be managed through the administration portal

For a complete reference of all available endpoints, request parameters, and response formats, please refer to our interactive Swagger documentation:

Market Data API Swagger Documentation

The Swagger interface allows you to:

  • Browse all available endpoints
  • Test API calls directly from your browser
  • View request and response schemas
  • Understand authentication requirements for each endpoint

This section will be expanded with detailed information about specific market definition endpoints, including:

  • How to retrieve available markets
  • Accessing instrument specifications
  • Querying trading parameters
  • Filtering and searching capabilities
  • developers/websocket/markets.1742051787.txt.gz
  • Last modified: 2025/03/15 15:16
  • by chad