Welcome

Welcome to the Zerocap OTC API. Using this API you'll be able to receive market data, place orders and get related information.

The API has two parts: a REST API for orders, quotes and account data (see the API Reference), and an authenticated Websocket feed for prices, order updates and fills (see Websocket Overview).

Getting Started

To connect, you must use a combination of the API Key and API Secret. These sets of credentials are specific to an account and cannot be generated by anyone except Zerocap. Zerocap will send you your credentials. Contact your account manager to get new credentials.

Every request is signed with your API Secret. Authentication describes the headers, the error responses and rate limits, and lists the production and sandbox URLs. Build and test your integration against the sandbox before you switch to production.

Quick Start

We recommend using the official Python SDK (Python 3.8 or later). It signs every request for you and has a method for every endpoint in the API Reference. First install the SDK:

pip install "zerocap-api>=0.1.36"

Then create a client. env is 'sandbox' or 'prod':

from zerocap_api import ZerocapRestClient

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'

client = ZerocapRestClient(api_key, api_secret, env='sandbox')
print(client.get_instruments())

Then start using the REST or Websocket clients.


What’s Next

Did this page help you?