Overview
Welcome to the Bullish Trading API documentation!
This documentation provides resource descriptions and endpoints usage instructions for the API.
API Overview
- follows REST conventions
- has the base URL
api.exchange.bullish.com(unless one of the sandbox environments is being used) - has endpoints under the below categories:
- Authenticated endpoints for private client data e.g. Get Orders endpoint
- Non-authenticated endpoints for public data e.g. Get Markets endpoint
- uses bearer-based authentication
- enforces a blanket rate limit across all requests
- may add new fields to existing response payloads. Please do not use strict deserialization as it may cause compatibility issues.
Quickly Try The API
To quickly try the API you can use the TRY green button which you can find on the bottom right side of each endpoint documentation section, next to FILL EXAMPLE and CLEAR buttons.
Try The Non-Authenticated Endpoints
To try the endpoints for which the authentication is not required follow below steps:
- Fill in the input parameters, including the request headers
- Click the
TRYgreen button - Inspect the results
Try The Authenticated Endpoints
To try the endpoints for which authentication is required follow below steps:
- Obtain a bearer token using your API key
- Set it in the dedicated
api-tokenfield in the Authentication section - Fill in the input parameters
- Click the
TRYgreen button - Inspect the results