Coindirect provides financial technology companies with access to its underlying tech platform via the Coindirect Cryptocurrency Web Services (CWS) API. The CWS API offers a crypto to fiat integration-as-a-service to anyone wanting to create a cryptocurrency application. At its heart, the Coindirect CWS connects the decentralised crypto ecosystem with traditional financial systems and exposes this connection as an easy to use API. Complete API coverage is provided for all of the features used by our consumer products, including:
- Coindirect Wallet: Buy, store and convert your cryptocurrencies.
- Coindirect Exchange: Trade with the biggest selection of cryptocurrencies.
- Coindirect Marketplace: Peer to peer bitcoin offer marketplace.
This document describes the Coindirect Cryptocurrency Web Services (CWS) REST API and everything that is necessary to access its resources. The Coindirect CWS API is organised around the following main categories:
- Accounts: The Accounts section provides you with methods to manage your affiliate earnings, account preferences and verification of your Coindirect account.
- Users: Use these methods to manage API keys, make updates to your user profile, manage passwords and 2FA codes and register new users.
- Vendor Applications: The Vendor Applications section allows you to manage your application with Coindirect as a Trade Vendor on our peer to peer marketplace.
- Currencies: View details of all supported currencies (fiat and crypto) using the methods in this section.
- Prices: The Prices section provides a snapshot view of the latest prices across all supported cryptocurrencies for a specific country and base currency.
- Sentiment: View the latest exchange rates and market sentiment for a specific cryptocurrency using the methods in this section.
- Exchange: The Exchange section provides access to historical and current market data and trade history and allows you to manage market and limit orders placed on the exchange.
- Transactions: View details of all transactions and transaction types using the methods in this section.
- Wallets: The Wallets section gives you the ability to create and manage the currency wallets in your Coindirect account as well as perform deposit, transfer and withdrawal transactions using those wallets.
- P2P Marketplace: If you are a Coindirect Trade Vendor in our peer to peer marketplace, these are the methods you will need to create and manage your offers and orders. An offer is a buy or sell price listing on the marketplace. An order is created when a customer takes up your offer and indicates they want to buy or sell coins at the listed price.
- Payment Methods: The Payment Methods section allows you to view, manage and create new payment methods.
- Payment Types and Categories: Closely linked to the above section, you can use the methods in the Payment Types and Categories section to view details of all payment method categories and types.
- Banking: Add a new bank listing and view details of all supported banks by country with the methods in this section.
- Countries: The Countries section allows you to view details of all supported countries on the platform.
- Languages: The Languages section allows you to view details of all supported languages on the platform.
All API requests are performed over HTTPS and follow JSON API conventions. All data is sent and received as JSON with the content type application/json.
In order to use the API, you first need to create a Coindirect user account. If you have not yet done so, please sign up here. Contact us at email@example.com if you have any difficulties signing up.
You will also need to have two factor authentication (2FA) enabled on your account in order to access your API key.
To use the Coindirect CWS API you have to first create an API key from within the Security section of your Coindirect account. Below is the step by step process to follow in order to generate such a key:
- Enable two factor authentication (2FA) on your Coindirect account by going to the Security page of your profile (accessible from the top-right drop down menu).
- Once 2FA is enabled on your account, return to the Security page.
- In the ‘Manage API keys’ section, generate a new API key by entering a description and your 2FA code and clicking the ‘Create’ button.
- The new API key will be displayed to you in the ‘Manage API keys’ section. Your secret key will also be displayed to you, however you will need to take note of this as this key will not be accessible later.
You can generate multiple API keys if required. Should you no longer require a specific API key, you can click the ‘Revoke’ button to deactivate the API key.
All calls to the Coindirect CWS API will be in the live environment. We unfortunately cannot provide access to a public staging or testing environment at this stage. The live base URL host for all API requests documented below is: https://api.coindirect.com
The API version is indicated in the request URL e.g. /v1/transaction indicates version 1. All changes made to the API are backwards compatible, hence any major features that are released, that would otherwise break existing implementations, will be released using a new version.
Many Coindirect API methods support a way to retrieve a list of records. For example, you can retrieve a list of transactions. When retrieving a list, you can control the number of records returned by adding two parameters to your request:
offset: This tells the Coindirect API where to start fetching the records.
max: This limits the number of records returned per page. The default is 10 records.
Coindirect CWS uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided and codes in the 5xx range indicate an error with Coindirect CWS’s servers (these are rare). The message returned is not always in a suitable format to present to the end-user. Where appropriate, detailed error descriptions are provided for each error code next to the relevant method in the API documentation. Please note that new error codes may be added and existing error codes may be removed without notice.
Navigate to the specific request, scroll down to the ‘Send a Test Request’ section and click the ‘Code Generator’ tab. From there select the language and library you’re looking for from the dropdown menus.