Margin Order – API Reference

docs.coindcx.com

Terminology

Common
target currency refers to the asset that is the quantity of a symbol.
base currency refers to the asset that is the price of a symbol.
pair uniquely identifies the market along with its exchange, and is available in
market details api.

Orders

status: used to denote the current status of the given order. Valid values for status
include:
init: order is just created, but not placed in the orderbook (eg: stop-limit
orders whose stop/trigger price hasn't reached)
open: order is successfully placed in the orderbook
partially_filled: order is partially filled
filled: order is completely filled
partially_cancelled: order is partially filled, but cancelled, thus inactive
cancelled: order is completely or partially cancelled
rejected: order is rejected (not placed on the exchange)
untriggered: order is untriggered (only applies to Futures Take Profit and
Stop Loss orders)

Among these, the open-equivalent status' includes:

init, open, partially_filled
Orders having any these status can undergo further change (like when they get filled or
cancelled).

And settled or closed-equivalent status' includes:

filled, partially_cancelled, cancelled, rejected
Orders having any of these status could not undergo any change.

Margin Orders

1/192
 status: used to denote the current status of the given margin order. Valid values for
status include:
init: order is just created, but not placed in the orderbook
open: order is successfully placed in the orderbook
partial_entry: internal entry order is partially filled
partial_close: internal target order is partially closed
cancelled: order is completely cancelled
rejected: order is rejected (not placed on the exchange)
close: order is completely filled
triggered: stop variant order triggered at specified stop price

order_type: used to denote the type of order to be placed. Valid values for
order_type includes:
market_order: in this order type we don't specify price; it is executed on the
market price
limit_order: in this order type we specify the price on which order is to be
executed
stop_limit: it is a type of limit order whether we specify stop price and a
price, once price reaches stop_price, order is placed on the given price
take_profit: it is a type of limit order whether we specify stop price and a
price, once price reaches stop_price, order is placed on the given price

Other Terms:
target_price: The price at which the trader plans to buy/sell or close the
order position is called the Target Price. When the Target price is hit, the trade
is closed and the trader’s funds are settled according to the P&L incurred.
Target price feature is available if the trader checks the Bracket order
checkbox.
sl_price: The price at which the trader wishes to Stop Loss is the SL Price.
stop_price: It is used in the Stop Variant order, to specify stop price

Margin Internal Orders

2/192
 status for internal orders: used to denote the type of internal orders. Valid values
for order_type includes:
initial: order is just created
open: order is successfully placed in the orderbook
partially_filled: order is partially filled
filled: order is completely filled
cancelled: order is completely cancelled
rejected: order is rejected (not placed on the exchange)
partially_cancelled: order is partially cancelled
untriggered: stop variant order was not triggered

Setup
To access CoinDCX Public APIs and Sockets you will need

Key and Secret

Programming and Scripting language (Python and Javascript)
Few Libraries (Socket.io, request module, Crypto module)

Follow below mentioned steps for completing the pre-requisite

1. You can get your API key and Secret as follows

Go to your CoinDCX profile section

Click API dashboard
Click Create API key button and enter label name and check Bind IP Address to
API key only if you wanna bind the API key with your IP
Enter email and SMS OTP
Store the Key and Secret visible on the screen

NOTE: If the Key is binded with the IP, then these API can only be used
with the binded IP and cannot be shared with ony other user having
different IP.

2. For Public APIs

a. Javascript:

We recommend using Node.js. We recommend that you use v14 and above You’ll need
to have the following 2 Node modules installed to be able to work with our APIs:

Request module
Crypto module

b. Python:

3/192
We recommend that you use Python 3.8 and above. We recommend that you do not use
Python 2 as it is on its path to be sunset. You can install/know more from the official
Python website

3. For Sockets

a. Javascript:

We recommend using Node.js. We recommend that you use v14 and above You’ll need
to have the following Node modules installed to be able to work with our APIs:

Socket.io: Please note only version 2.4.0 of this module would work with our
Websockets. Please check this version in package.json

You can install the specific version by using the command

npm install [email protected]

b. Python:

We recommend that you use Python 3.8 and above. We recommend that you do not use
Python 2 as it is on its path to be sunset. You can install/know more from the official
Python website

YAY!!, You are all set to access CoinDCX Public APIs and Sockets

SPOT API Rate Limits

API Name Rate Limit Period

Create Order Multiple 2000 60s

Create Order 2000 60s

Cancel All 30 60s

Multiple Order Status 2000 60s

Order Status 2000 60s

Cancel Multiple by ID 300 60s

Cancel 2000 60s

Active Order 300 60s

Edit Price 2000 60s

Public endpoints

4/192
Ticker

HTTP Request
GET /exchange/ticker

import requests # Install requests module first.

url = "https://api.coindcx.com/exchange/ticker"

response = requests.get(url)
data = response.json()
print(data)

Response

[
{
"market": "REQBTC",
"change_24_hour": "-1.621",
"high": "0.00002799",
"low": "0.00002626",
"volume": "14.10",
"last_price": "0.00002663",
"bid": "0.00002663",
"ask": "0.00002669",
"timestamp": 1524211224
}
]

Definitions
bid - Highest bid offer in the orderbook
ask - Highest ask offer in the orderbook
high - 24 hour high
low - 24 hour low
volume - Volume of the market in last 24 hours.
timestamp - Time when this ticker was generated

A ticker is generated once every second

Markets

HTTP Request
GET /exchange/v1/markets

5/192
import requests # Install requests module first.

url = "https://api.coindcx.com/exchange/v1/markets"

response = requests.get(url)
data = response.json()
print(data)

Respose:

[
"SNTBTC",
"TRXBTC",
"TRXETH"
.
.
]

Returns an array of strings of currently active markets.

Markets details

HTTP Request
GET /exchange/v1/markets_details

import requests # Install requests module first.

url = "https://api.coindcx.com/exchange/v1/markets_details"

response = requests.get(url)
data = response.json()
print(data)

Response:

6/192
[
{
"coindcx_name": "SNMBTC",
"base_currency_short_name": "BTC",
"target_currency_short_name": "SNM",
"target_currency_name": "Sonm",
"base_currency_name": "Bitcoin",
"min_quantity": 1,
"max_quantity": 90000000,
"min_price": 5.66e-7,
"max_price": 0.0000566,
"min_notional": 0.001,
"base_currency_precision": 8,
"target_currency_precision": 0,
"step": 1,
"order_types": [ "take_profit", "stop_limit", "market_order", "limit_order" ],
"symbol": "SNMBTC",
"ecode": "B",
"max_leverage": 3,
"max_leverage_short": null,
"pair": "B-SNM_BTC",
"status": "active"
}
]

Response Param Definitions

Parameter Definitions

min_quantity It is the minimum quantity of target currency (SNT) for

which an order may be placed

max_quantity It is the maximum quantity of target currency (SNT) for

which an order may be placed

min_notional It is the minimum amount of base currency (BTC) for which

an order may be placed

base_currency_precision Number of decimals accepted for the base currency

target_currency_precision Number of decimals accepted for the target currency

step It is the minimum increment accepted for the target

currency

pair It is a string created by (ecode,

target_currency_short_name,
base_currency_short_name). It can be used to connect to
DcxStreams socket for API trading. For example: B-
BTC_USDT, I-BTC_INR, KC-XYZ_USDT

min_price It is the minimum Price for which an order may be placed

7/192
 Parameter Definitions

max_price It is the maximum Price for which an order may be placed

order_types Different type of orders that can be placed for the market.
For example: limit_order, market_order etc

max_leverage It is the max leverage for long positions that is available in

this market for margin trading

max_leverage_short It is the max leverage for short positions that is available in

this market for margin trading

status This states if a market can be used for trading. Possible

values could be active or inactive

Trades
The base URL for Trades API call is https://public.coindcx.com

HTTP request
GET /market_data/trade_history

import requests # Install requests module first.

url = "https://public.coindcx.com/market_data/trade_history?pair=B-
BTC_USDT&limit=50" # Replace 'B-BTC_USDT' with your desired market pair.

response = requests.get(url)
data = response.json()
print(data)

Response

[
{
"p": 11603.88,
"q": 0.023519,
"s": "BTCUSDT",
"T": 1565163305770,
"m": false
}
]

Query parameters

Name Required Example

pair Yes B-SNT_BTC (pair from Market Details API)

8/192
 Name Required Example

limit No Default: 30; Max: 500

This API provides with a sorted list of most recent 30 trades by default if limit parameter is
not passed.

Definitions

p is the trade price

q is the quantity
s is the market name
T is the timestamp of trade
m stands for whether the buyer is market maker or not.

Order book
The base URL for Order book API call is https://public.coindcx.com

import requests # Install requests module first.

url = "https://public.coindcx.com/market_data/orderbook?pair=B-BTC_USDT" # Replace

'SNTBTC' with the desired market pair.

response = requests.get(url)
data = response.json()
print(data)

Response

9/192
{
"bids":{
"11570.67000000": "0.000871",
"11570.58000000": "0.001974",
"11570.02000000": "0.280293",
"11570.00000000": "5.929216",
"11569.91000000": "0.000871",
"11569.89000000": "0.0016",
,
,
,
},
"asks":{
"13900.00000000": "27.04094600",
"13100.00000000": "15.48547100",
"12800.00000000": "36.93142200",
"12200.00000000": "92.04554800",
"12000.00000000": "72.66595000",
"11950.00000000": "17.16624600",
,
,
,
},

HTTP request
GET /market_data/orderbook

Query parameters

Name Required Example

pair Yes B-BTC_USDT (pair from Market Details API)

Candles
The base URL for Candles API call is https://public.coindcx.com

import requests # Install requests module first.

url = "https://public.coindcx.com/market_data/candles?pair=B-BTC_USDT&interval=1m"
# Replace 'SNTBTC' with the desired market pair.

response = requests.get(url)
data = response.json()
print(data)

Response

10/192
[
{
"open": 0.011803, // open price
"high": 0.011803, // highest price
"low": 0.011803, // lowest price
"volume": 0.35, // total volume in terms of target currency (in BTC for
B-BTC_USDT)
"close": 0.011803, // close price
"time": 1561463700000 //open time in ms
}
.
.
.
],

HTTP request
GET /market_data/candles

Query parameters

Name Required Example

pair Yes B-BTC_USDT (pair from Market Details API)

interval Yes any of the valid intervals given below

startTime No timestamp in ms, eg: 1562855417000

endTime No timestamp in ms, eg: 1562855417000

limit No Default: 500; Max: 1000

This API provides with a sorted list (in descending order according to time key) of
candlestick bars for given pair. Candles are uniquely identified by their time.

Valid intervals

m -> minutes, h -> hours, d -> days, w -> weeks, M -> months

1m
5m
15m
30m
1h
2h
4h
6h
8h

11/192
 1d
3d
1w
1M

Authentication
Common Notes:
All the Authenticated API calls use POST method.
Parameters are to be passed as JSON in the request body.
Every request must contain a timestamp parameter of when the request was
generated. This timestamp is used to validate that the request is not a very old one
(due to some lag in any layer) - the request is rejected with an appropriate error if
this timestamp deviates too much from the server's time at which it is received to be
processed.

To authorize, use this code:

12/192
 require 'net/http'
require 'uri'
require 'json'
require 'openssl'

secret = "Your secret key"

key = "Your API key"

payload = {
"side" : "buy",
"order_type" : "limit_order",
"price_per_unit": 0.00001724,
"market" : "SNTBTC",
"total_quantity" : 100,
"timestamp": 1524211224
}.to_json

signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), secret,

payload)

headers = {
'Content-Type' => 'application/json',
'X-AUTH-APIKEY' => key,
'X-AUTH-SIGNATURE' => signature
}

uri = URI.parse("https://api.coindcx.com/exchange/v1/orders/create")

https = Net::HTTP.new(uri.host, uri.port)

https.use_ssl = true
request = Net::HTTP::Post.new(uri.path, headers)

request.body = payload

response = https.request(request)

Sample order creation with auth

13/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy", #Toggle between 'buy' or 'sell'.
"order_type": "limit_order", #Toggle between a 'market_order' or 'limit_order'.
"market": "SNTBTC", #Replace 'SNTBTC' with your desired market pair.
"price_per_unit": 0.03244, #This parameter is only required for a 'limit_order'
"total_quantity": 400, #Replace this with the quantity you want
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/create"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Make sure to replace API key and API secret with your own.

The authentication procedure is as follows:

The payload is the parameters object, JSON encoded

14/192
 payload = parameters-object -> JSON encode
The signature is the hex digest of an HMAC-SHA256 hash where the message is
your payload, and the secret key is your API secret.
signature = HMAC-SHA256(payload, api-secret).digest('hex')

After this, You will have to add following headers into all the authenticated requests

Header Name Value

X-AUTH-APIKEY your-api-key

X-AUTH-SIGNATURE signature

You must replace your-api-key and signature with your personal API key and
generated signature respectively.

User

Get balances

15/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/users/balances"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json();
print(data);

Response:

[
{
"currency": "BTC",
"balance": 1.167,
"locked_balance": 2.1
}
]

Locked balance is the balance currently being used by an open order

16/192
This endpoint retrieves account's balances.

HTTP Request
POST /exchange/v1/users/balances

Get user info

import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/users/info"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json();
print(data);

17/192
 Response:

[
{
"coindcx_id": "fda259ce-22fc-11e9-ba72-ef9b29b5db2b",
"first_name": "First name",
"last_name": "Last name",
"mobile_number": "000000000",
"email": "[email protected]"
}
]

coindcx_id is the user id

This endpoint retrieves user info.

HTTP Request
POST /exchange/v1/users/info

Sub-account Wallet Transfer

The sub-account transfer APIs will enable the user to manage funds between master
account & its corresponding sub-accounts

Sub Account Transfer

Using this endpoint,master account can carry out the following fund transfers:

Main account spot wallet to sub-account spot wallet

Sub-account spot wallet to main account spot wallet
One sub-account spot wallet to another sub-account spot wallet

For security reasons, this endpoint would only be available to users who have created an
API key post 12th August, 2024.

HTTP Request
POST https://api.coindcx.com/exchange/v1/wallets/sub_account_transfer

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

from_account_id String YES The account from which assets are

being transferred (main or sub-account
ID)

18/192
to_account_id String YES The account to which assets are being
transferred (main or sub-account ID)

currency_short_name String YES The type of asset being transferred

(e.g., BTC, ETH).

amount Float YES The amount of the asset to transfer

Possible Error Codes

Status
Code Message Reason

422 Invalid transfer invalid from_account_id or

to_account_id passed

401 Unauthorized access Transfer initiated by sub

account user

400 Currency short name not present Invalid

currency_short_name
provided

404 source wallet not found Source currency wallet is

not created for user

404 destination wallet not found Destination currency wallet

is not created for user

422 Unverified Sub-Account Email verification pending

for sub account user

400 Insufficient funds Amount to be transferred is

more than the available
wallet balance

422 Amount should be greater than Amount should be greater

than

422 Your withdrawals are blocked for another XX User is under surveillance
hours because you changed your account
authentication mode

19/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')

# python2
# secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"from_account_id": "xxxxx",
"to_account_id": "yyyyy",
"currency_short_name": "USDT",
"amount": 1,
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/wallets/sub_account_transfer"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(json.dumps(data, indent=2))

Response

{
"status": "success",
"message": 200,
"code": 200
}

20/192
Wallet Transfer
Using this endpoint,master account can carry out the following fund transfers:

Transfer from spot to futures wallet

Transfer from futures to spot wallet

HTTP Request
POST https://api.coindcx.com/exchange/v1/wallets/transfer

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

source_wallet_type Enum YES The wallet type from which balance

has to be transferred (spot / futures)

destination_wallet_type Enum YES The wallet type from which balance

has to be transferred (spot / futures)

currency_short_name String YES The type of asset being transferred

(e.g., BTC, ETH).

amount Float YES The amount of the asset to transfer

Possible Error Codes

Status
Code Message Reason

422 Invalid amount Amount to be transferred

should be positive

422 Invalid currency Invalid currency_short_name

provided

422 Derivatives Futures Wallet creation is not Futures wallet creation not
allowed for currency_short_name: allowed for currency
<currency_short_name>

422 This feature is not enabled yet. Futures wallet not enabled for
user

404 Wallet not found Futures wallet not created for

user

400 Insufficient funds Amount to be transferred is

more than the available wallet
balance

21/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')

# python2
# secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"source_wallet_type": "futures",
"destination_wallet_type": "spot",
"currency_short_name": "USDT",
"amount": 1,
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/wallets/transfer"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(json.dumps(data, indent=2))

Response

{
"status": "success",
"message": 200,
"code": 200
}

22/192
Order
Enum definitions for the purpose of order are as follows:

Name Values

side buy, sell

order_type market_order, limit_order

order_status open, partially_filled, filled, cancelled, rejected, partially_cancelled, init

ecode I, B, HB, KC

New order

23/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy", #Toggle between 'buy' or 'sell'.
"order_type": "limit_order", #Toggle between a 'market_order' or 'limit_order'.
"market": "SNTBTC", #Replace 'SNTBTC' with your desired market pair.
"price_per_unit": 0.03244, #This parameter is only required for a 'limit_order'
"total_quantity": 400, #Replace this with the quantity you want
"timestamp": timeStamp,
"client_order_id": "2022.02.14-btcinr_1" #Replace this with the client order id
you want
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/create"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

24/192
{
"orders":[
{
"id":"ead19992-43fd-11e8-b027-bb815bcb14ed",
"client_order_id": "2022.02.14-btcinr_1",
"market":"TRXETH",
"order_type":"limit_order",
"side":"buy",
"status":"open",
"fee_amount":0.0000008,
"fee":0.1,
"total_quantity":2,
"remaining_quantity":2.0,
"avg_price":0.0,
"price_per_unit":0.00001567,
"created_at":"2018-04-19T18:17:28.022Z",
"updated_at":"2018-04-19T18:17:28.022Z"
}
]
}

Use this endpoint to place a new order on the exchange

You can only have a maximum of 25 open orders at a time for one specific market

HTTP Request
POST /exchange/v1/orders/create

Request Parameters

Name Required Example Description

market Yes SNTBTC The trading pair

total_quantity Yes 1.101 Quantity to trade

price_per_unit No 0.082 Price per unit (not required for market

order)

side Yes buy Specify buy or sell

order_type Yes market_order Order Type

client_order_id No 2022.02.14- Client order id of the order

btcinr_1

timestamp Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes' under
'Authentication' heading to read more)

Response Parameters

25/192
 Name Description

id It's system generated order id

client_order_id It's provided while placing order by the user

market Market for which order has been placed

side Side provided while placing order

order_type Order Type provided while placing order

status This tells the current status of the order. For example: When the
order firstly is placed, the status shows open

fee_amount Amount of fee charged to the user if the order gets executed and
moved to the filled status

fee This is a Fee in percentage that is used to calculate fee_amount

total_quantity Quantity provided while placing order

remaining_quantity Quantity remaining to be filled

avg_price The price on which the user's order gets executed, it's 0.0 when
order is in open status

price_per_unit price_per_unit provided while placing order

created_at It's a time when order was placed

updated_at It's a time when anything related to the order was updated. For
example avg_price, total_quantity, status etc

Create multiple orders

Multiple ordering API is only supported for CoinDCX INR markets. Set ecode parameter
to I

26/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"orders": [
{
"side": "buy", #Toggle between 'buy' or 'sell'.
"order_type": "limit_order", #Toggle between a 'market_order' or
'limit_order'.
"market": "SNTBTC", #Replace 'SNTBTC' with your desired market pair.
"price_per_unit": 0.03244, #This parameter is only required for a
'limit_order'
"total_quantity": 400, #Replace this with the quantity you want
"timestamp": timeStamp,
"ecode": "I",
"client_order_id": "2022.02.14-btcinr_1" #Replace this with the client order
id you want
},
{
"side": "buy", #Toggle between 'buy' or 'sell'.
"order_type": "limit_order", #Toggle between a 'market_order' or
'limit_order'.
"market": "SNTBTC", #Replace 'SNTBTC' with your desired market pair.
"price_per_unit": 0.03244, #This parameter is only required for a
'limit_order'
"total_quantity": 400, #Replace this with the quantity you want
"timestamp": timeStamp,
"ecode": "I"
}
]
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/create_multiple"

27/192
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"orders":[
{
"id":"ead19992-43fd-11e8-b027-bb815bcb14ed",
"client_order_id": "2022.02.14-btcinr_1",
"market":"TRXETH",
"order_type":"limit_order",
"side":"buy",
"status":"open",
"fee_amount":0.0000008,
"fee":0.1,
"total_quantity":2,
"remaining_quantity":2.0,
"avg_price":0.0,
"price_per_unit":0.00001567,
"created_at":"2018-04-19T18:17:28.022Z",
"updated_at":"2018-04-19T18:17:28.022Z"
}
]
}

Use this endpoint to place a multiple orders on the exchange

HTTP Request
POST /exchange/v1/orders/create_multiple

Parameters in an array of objects

Name Required Example Description

market Yes SNTBTC The trading pair

total_quantity Yes 1.101 Quantity to trade

price_per_unit No 0.082 Price per unit (not required for market

order)

28/192
Name Required Example Description

side Yes buy Specify buy or sell

order_type Yes market_order Order Type

ecode Yes I Exchange code

client_order_id No 2022.02.14- Client order id of the order

btcinr_1

timestamp Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes' under
'Authentication' heading to read more)

Order status

29/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "ead19992-43fd-11e8-b027-bb815bcb14ed", # Enter your Order ID here.
# "client_order_id": "2022.02.14-btcinr_1", # Enter your Client Order ID here.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/status"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

30/192
{
"id":"ead19992-43fd-11e8-b027-bb815bcb14ed",
"client_order_id": "2022.02.14-btcinr_1",
"market":"TRXETH",
"order_type":"limit_order",
"side":"buy",
"status":"open",
"fee_amount":0.0000008,
"fee":0.1,
"total_quantity":2,
"remaining_quantity":2.0,
"avg_price":0.0,
"price_per_unit":0.00001567,
"created_at":"2018-04-19T18:17:28.022Z",
"updated_at":"2018-04-19T18:17:28.022Z"
}

Use this endpoint to fetch status of any order

HTTP Request
POST /exchange/v1/orders/status

Parameters

Name Required Example Description

id No ead19992-43fd- The ID of the order

11e8-b027-
bb815bcb14ed

client_order_id No 2022.02.14- The Client Order ID of the order

btcinr_1

timestamp Yes 1524211224 When was the request generated (see

'Common Notes' under 'Authentication'
heading to read more)

Note: id or client_order_id one of the paramter is required.

Multiple order status

31/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
# "ids": ["8a2f4284-c895-11e8-9e00-5b2c002a6ff4", "8a1d1e4c-c895-11e8-9dff-
df1480546936"], # Array of Order ids
"client_order_ids": ["2022.02.14-btcinr_1", "2022.02.14-btcinr_2"], # Array of
Client Order ids
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/status_multiple"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

32/192
[
{
"id":"ead19992-43fd-11e8-b027-bb815bcb14ed",
"client_order_id": "2022.02.14-btcinr_1",
"market":"TRXETH",
"order_type":"limit_order",
"side":"buy",
"status":"open",
"fee_amount":0.0000008,
"fee":0.1,
"total_quantity":2,
"remaining_quantity":2.0,
"avg_price":0.0,
"price_per_unit":0.00001567,
"created_at":"2018-04-19T18:17:28.022Z",
"updated_at":"2018-04-19T18:17:28.022Z"
}
]

Use this endpoint to fetch status of any order

HTTP Request
POST /exchange/v1/orders/status_multiple

Parameters

Name Required Example Description

ids No ["ead19992-43fd-11e8- Array of order IDs

b027-bb815bcb14ed",
"8a1d1e4c-c895-11e8-
9dff-df1480546936"]

client_order_ids No ["2022.02.14-btcinr_1", Array of client order IDs

"2022.02.14-btcinr_2"]

timestamp Yes 1524211224 Timestamp at which the

request was generated (see
'Common Notes' under
'Authentication' heading to
read more)

Note: id or client_order_id one of the paramter is required.

Active orders

33/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy", # Toggle between a 'buy' or 'sell' order.
"market": "SNTBTC", # Replace 'SNTBTC' with your desired market pair.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/active_orders"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

34/192
[
{
"id":"ead19992-43fd-11e8-b027-bb815bcb14ed",
"client_order_id": "2022.02.14-btcinr_1",
"market":"TRXETH",
"order_type":"limit_order",
"side":"buy",
"status":"open",
"fee_amount":0.0000008,
"fee":0.1,
"total_quantity":2,
"remaining_quantity":2.0,
"avg_price":0.0,
"price_per_unit":0.00001567,
"created_at":"2018-04-19T18:17:28.022Z",
"updated_at":"2018-04-19T18:17:28.022Z"
}
]

Use this endpoint to fetch active orders

HTTP Request
POST /exchange/v1/orders/active_orders

Parameters

Name Required Example Description

market Yes SNTBTC

side No buy

timestamp Yes 1524211224 Timestamp at which the request was generated

(see 'Common Notes' under 'Authentication'
heading to read more)

Account Trade history

35/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"from_id": 352622,
"limit": 50,
"timestamp": timeStamp,
"sort": "asc",
"from_timestamp": 1514745000000, # replace this with your from timestamp filter
"to_timestamp": 1514745000000, # replace this with your to timestamp filter
"symbol": "BCHBTC" # replace this with your symbol filter
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/trade_history"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

36/192
[
{
"id": 564389,
"order_id": "ee060ab6-40ed-11e8-b4b9-3f2ce29cd280",
"side": "buy",
"fee_amount": "0.00001129",
"ecode": "B",
"quantity": 67.9,
"price": 0.00008272,
"symbol": "SNTBTC",
"timestamp": 1533700109811
}
]

Use this endpoint to fetch trades associated with your account

HTTP Request
POST /exchange/v1/orders/trade_history

Parameters

Name Required Example Description

limit No 100 Default: 500, Min: 1, Max: 5000

from_id No 28473 Trade ID after which you want the

data. If not supplied, trades in
ascending order will be returned

sort No asc Specify asc or desc to get trades in

ascending or descending order,
default: asc

timestamp Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes'
under 'Authentication' heading to read
more)

from_timestamp No 1514745000000 Timestamp after which you want the

data. If not supplied, all trades from
starting will be returned

to_timestamp No 1514745000000 Timestamp before which you want the

data. If not supplied, all trades till now
will be returned

symbol No SNTBTC Symbol for which you want the data.

If not supplied, trades from all
symbols will be returned

Active orders count

37/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy", # Toggle between a 'buy' or 'sell' order.
"market": "SNTBTC", # Replace 'SNTBTC' with your desired market pair.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/active_orders_count"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{ count: 1, status: 200 }

Use this endpoint to fetch active orders count

38/192
HTTP Request
POST /exchange/v1/orders/active_orders_count

Parameters

Name Required Example Description

market Yes SNTBTC

side No buy

timestamp Yes 1524211224 Timestamp at which the request was generated

(see 'Common Notes' under 'Authentication'
heading to read more)

Cancel all

39/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy", # Toggle between a 'buy' or 'sell' order.
"market": "SNTBTC", # Replace 'SNTBTC' with your desired market pair.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/cancel_all"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

Use this endpoint to cancel multiple active orders in a single API call

HTTP Request
POST /exchange/v1/orders/cancel_all

40/192
Parameters

Name Required Example Description

market Yes SNTBTC

side No buy

timestamp Yes 1524211224 Timestamp at which the request was generated

(see 'Common Notes' under 'Authentication'
heading to read more)

Sending side param is optional. You may cancel all the sell orders of SNTBTC by sending
{market: "SNTBTC", side : "sell"}

Or you may cancel all your orders in SNTBTC market by sending

{market: "SNTBTC"}

Cancel multiple By Ids

41/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"ids": ["8a2f4284-c895-11e8-9e00-5b2c002a6ff4", "8a1d1e4c-c895-11e8-9dff-
df1480546936"]
# "client_order_ids": ["2022.02.14-btcinr_1", "2022.02.14-btcinr_2"] # Array of
client_order_ids
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/cancel_by_ids"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

Use this endpoint to cancel multiple active orders in a single API call

HTTP Request

42/192
POST /exchange/v1/orders/cancel_by_ids

Parameters

Name Required Example Description

ids No ["8a2f4284-c895-11e8-9e00- Array of

5b2c002a6ff4", "8a1d1e4c-c895-11e8- order IDs
9dff-df1480546936"]

client_order_ids No ["2022.02.14-btcinr_1", "2022.02.14- Array of

btcinr_2"] Client Order
IDs

Note: id or client_order_id one of the paramter is required.

Cancel

43/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from CoinDCX website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "ead19992-43fd-11e8-b027-bb815bcb14ed", # Enter your Order ID here.
# "client_order_id": "2022.02.14-btcinr_1", # Enter your Client Order ID here.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/cancel"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

Use this endpoint to cancel an active orders

HTTP Request
POST /exchange/v1/orders/cancel

44/192
Parameters

Name Required Example Description

id No ead19992- The ID of the order

43fd-11e8-
b027-
bb815bcb14ed

client_order_id No 2022.02.14- The Client Order ID of the order

btcinr_1

timestamp Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes' under
'Authentication' heading to read more)

Note: id or client_order_id one of the paramter is required.

Edit Price

45/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from CoinDCX website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # Enter your Order ID here.
"timestamp": timeStamp,
"price_per_unit": 123.45 # Enter the new-price here
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/orders/edit"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

46/192
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"market": "TRXETH",
"order_type": "limit_order",
"side": "buy",
"status": "open",
"fee_amount": 0.0000008,
"fee": 0.1,
"total_quantity": 2,
"remaining_quantity": 2.0,
"avg_price": 0.0,
"price_per_unit": 123.45,
"created_at": "2020-12-12T18:17:28.022Z",
"updated_at": "2020-12-12T18:17:28.022Z"
}

Use this endpoint to edit the price of an active order

HTTP Request
POST /exchange/v1/orders/edit

Parameters

Name Required Example Description

id No ead19992- The ID of the order

43fd-11e8-
b027-
bb815bcb14ed

client_order_id No 2022.02.14- The Client Order ID of the order

btcinr_1

price_per_unit Yes 123.45 New Price for the order

timestamp Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes' under
'Authentication' heading to read more)

Note: id or client_order_id one of the paramter is required.

Lend Order

Fetch Orders
This API supports Pagination Refer Pagination section for more details

47/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/funding/fetch_orders"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

48/192
[ { "id": "caa1e032-5763-42a5-9684-587bc1a846d8",
"currency_short_name": "USDT",
"amount": 0.01,
"title": "Tether",
"interest": 0.1,
"interest_type": "simple",
"duration": 8,
"side": "lend",
"expiry": 1564666811940,
"status": "close",
"created_at": 1563975611942,
"settled_at": 1565615166177 },
{ "id": "1212ad3d-8a5b-4965-9d21-151efc0c84d7",
"currency_short_name": "BTC",
"amount": 0.01,
"title": "Bitcoin",
"interest": 0.1,
"interest_type": "simple",
"duration": 8,
"side": "lend",
"expiry": 1564666764834,
"status": "close",
"created_at": 1563975564836,
"settled_at": 1563975597184 } ]

Use this endpoint to fetch orders and its details

HTTP Request
POST /exchange/v1/funding/fetch_orders

Parameters

Name Type Required Example Description

timestamp number Yes 1524211224 Timestamp at which the request was

generated (see 'Common Notes'
under 'Authentication' heading to
read more)

Lend

49/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"currency_short_name": "BTC",
"duration": 20,
"amount": 0.5,
"timestamp": timeStamp
}
json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/funding/lend"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

50/192
[ { "id": "df7d9640-29e8-4731-9fc6-ec2f738507e2",
"currency_short_name": "XRP",
"amount": 11,
"interest": 0.05,
"title": "Ripple",
"interest_type": "simple",
"duration": 20,
"side": "lend",
"expiry": 1576069883995,
"status": "open",
"created_at": 1574341883998,
"settled_at": null } ]

Use this endpoint to lend specified currency on the exchange.

HTTP Request
POST /exchange/v1/funding/lend

Parameters

Name Type Required Example Description

currency_short_name string Yes XRP The lending currency

amount number Yes 11 Quantity to lend

duration number Yes 20 The Time period for which

you want to lend the
currency in days

timestamp number Yes 1524211224 Timestamp at which the

request was generated
(see 'Common Notes'
under 'Authentication'
heading to read more)

Settle

51/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from CoinDCX website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "ead19992-43fd-11e8-b027-bb815bcb14ed",
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/funding/settle"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

52/192
[ { "id": "df7d9640-29e8-4731-9fc6-ec2f738507e2",
"currency_short_name": "XRP",
"amount": 11,
"interest": 0.05,
"title": "Ripple",
"interest_type": "simple",
"duration": 20,
"side": "lend",
"expiry": 1576069883995,
"status": "exit",
"created_at": 1574341883998,
"settled_at": 1574342058493 } ]

Use this endpoint to settle lend order.

HTTP Request
POST /exchange/v1/funding/settle

Parameters

Name Type Required Example Description

id string Yes ead19992- The ID of the order

43fd-11e8-
b027-
bb815bcb14ed

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Margin Order
Set ecode parameter to B for all the api calls wherever necessary
Enum definitions for the purpose of order are as follows:

Name Values

side buy, sell

order_type market_order, limit_order, stop_limit, take_profit

order_status init, partial_entry, open, partial_close, close, cancelled, rejected,

triggered

timestamp 1524211224

53/192
Name Values

ecode B

Place Order

54/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"side": "buy",
"order_type": "limit_order",
"market": "XRPBTC",
"price": 0.000025,
"quantity": 90,
"ecode": 'B',
"leverage": 1.0,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/create"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

55/192
[{
"id": "30b5002f-d9c1-413d-8a8d-0fd32b054c9c",
"side": "sell",
"status": "init",
"market": "XRPBTC",
"order_type": "limit_order",
"trailing_sl": false,
"trail_percent": null,
"avg_entry": 0,
"avg_exit": 0,
"fee": 0.02,
"entry_fee": 0,
"exit_fee": 0,
"active_pos": 0,
"exit_pos": 0,
"total_pos": 0,
"quantity": 200,
"price": 0.000026,
"sl_price": 0.00005005,
"target_price": 0,
"stop_price": 0,
"pnl": 0,
"initial_margin": 0.00520208,
"interest": 0.05,
"interest_amount": 0,
"leverage": 1,
"result": null,
"created_at": 1568122929782,
"updated_at": 1568122929782,
"orders":[{
"id": 164993,
"order_type": "limit_order",
"status": "initial",
"market": "XRPBTC",
"side": "sell",
"avg_price": 0,
"total_quantity": 200,
"remaining_quantity": 200,
"price_per_unit": 0.000026,
"timestamp": 1568122929880.75,
"fee": 0.02,
"fee_amount": 0,
"filled_quantity": 0,
"bo_stage": "stage_entry",
"cancelled_quantity": 0,
"stop_price": 0
}]
}]

Use this endpoint to place a new order on the exchange.

You can only have a maximum of 10 open orders at a time for one specific market

HTTP Request

56/192
POST /exchange/v1/margin/create

Parameters

Name Type Required Example Description

market string Yes XRPBTC The trading pair

quantity number Yes 1.101 Quantity to trade

price number No 0.082 Price per unit (not required for

market order, mandatory for rest)

leverage number No 1 Borrowed capital to increase the

potential returns

side string Yes buy Specify buy or sell

stop_price number No 0.082 Price to stop the order

at(mandatory in case of stop_limit
& take_profit)

order_type string Yes market_order Order Type

trailing_sl boolean No true To place order with Trailing Stop

Loss

target_price number No 0.082 The price to buy/sell or close the

order position

ecode string Yes B Exchange code in which the order

will be placed

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Cancel Order
Any order with order_status among the following can only be cancelled:
init, partial_entry, or triggered

57/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "ead19992-43fd-11e8-b027-bb815bcb14ed",
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/cancel"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"message": "Cancellation accepted",
"status": 200,
"code": 200
}

Use this endpoint to cancel any order.

58/192
HTTP Request
POST /exchange/v1/margin/cancel

Parameters

Name Type Required Example Description

id string Yes ead19992- The ID of the order

43fd-11e8-
b027-
bb815bcb14ed

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Exit
Any order with order_status among the following can only be exited:
open or partial_close

59/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from CoinDCX website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "ead19992-43fd-11e8-b027-bb815bcb14ed",
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/exit"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"message": "Order exit accepted",
"status": 200,
"code": 200
}

Use this endpoint to exit any order.

60/192
HTTP Request
POST /exchange/v1/margin/exit

Parameters

Name Type Required Example Description

id string Yes ead19992- The ID of the order

43fd-11e8-
b027-
bb815bcb14ed

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Edit Target
You can update target price only if order has 0 or 1 target order. For the multiple open
targets refer- Edit Price of Target Order section

61/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "8a2f4284-c895-11e8-9e00-5b2c002a6ff4",
"target_price": 0.6,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/edit_target"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"message": "Target price updated",
"status": 200,
"code": 200
}

62/192
Use this endpoint to edit the target price of any order.

HTTP Request
POST /exchange/v1/margin/edit_target

Parameters

Name Type Required Example Description

id string Yes 8a2f4284- ID of the order to edit

c895-11e8-
9e00-
5b2c002a6ff4

target_price number Yes 0.082 The new price to buy/sell or close

the order position at

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Edit Price of Target Order

63/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id": "",
"target_price": 0.00026,
"itpo_id": "",
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/edit_price_of_target_order"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"message": "Target price updated",
"status": 200,
"code": 200
}

64/192
Use this endpoint to edit price of internal target order.

HTTP Request
POST /exchange/v1/margin/edit_price_of_target_order

Parameters

Name Type Required Example Description

id string Yes ead19992-

43fd-11e8-
b027-
bb815bcb14ed

target_price number Yes 0.082 The new price to buy/sell or close

the order position at

itpo_id string Yes 164968 ID of internal order to edit

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Edit SL Price
Only for orders where trailing_sl is false

65/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id" : "",
"sl_price": 0.06,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/edit_sl"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

{
"message": "SL price updated",
"status": 200,
"code": 200
}

Use this endpoint to edit stop loss price of a bracket order.

HTTP Request

66/192
POST /exchange/v1/margin/edit_sl

Parameters

Name Type Required Example Description

id string Yes ead19992- ID of Margin Order

43fd-11e8-
b027-
bb815bcb14ed

sl_price number Yes 0.082 The price to Stop Loss at

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Edit SL Price of Trailing Stop Loss

Only for orders where trailing_sl is true

67/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id" : "",
"sl_price": 0.06,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/edit_trailing_sl"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

{
"message": "Trailing SL price updated",
"status": 200,
"code": 200
}

Use this endpoint to edit stop loss price of a trailing stop loss order.

HTTP Request

68/192
POST /exchange/v1/margin/edit_trailing_sl

Parameters

Name Type Required Example Description

id string Yes ead19992- ID of Margin Order

43fd-11e8-
b027-
bb815bcb14ed

sl_price number Yes 0.082 The new price to Stop Loss at

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Add Margin

69/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id" : "",
"amount": 0.06,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/add_margin"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

{
"message": "Margin added successfully",
"status": 200,
"code": 200
}

Use this endpoint to add a particular amount to your margin order, decreasing the
effective leverage.

70/192
HTTP Request
POST /exchange/v1/margin/add_margin

Parameters

Name Type Required Example Description

id string Yes ead19992- ID of Margin Order

43fd-11e8-
b027-
bb815bcb14ed

amount number Yes 0.06 Amount to add in the margin to

decrease effective leverage

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Remove Margin

71/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"id" : "",
"amount": 0.06, initial margin.
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/remove_margin"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

{
"message": "Margin removed successfully",
"status": 200,
"code": 200
}

Use this endpoint to remove a particular amount from your Margin order, increasing the
effective leverage.

72/192
HTTP Request
POST /exchange/v1/margin/remove_margin

Parameters

Name Type Required Example Description

id string Yes ead19992- ID of Margin Order

43fd-11e8-
b027-
bb815bcb14ed

amount number Yes 0.06 Amount to remove from the margin

to increase effective leverage

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Fetch Orders
This API supports Pagination Refer Pagination section for more details

73/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"details": True,
"market": "LTCBTC",
"status":"close",
"size":20,
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/fetch_orders"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

74/192
[{
"id": "30b5002f-d9c1-413d-8a8d-0fd32b054c9c",
"side": "sell",
"status": "rejected",
"market": "XRPBTC",
"order_type": "limit_order",
"trailing_sl": false,
"trail_percent": null,
"avg_entry": 0,
"avg_exit": 0,
"fee": 0.02,
"entry_fee": 0,
"exit_fee": 0,
"active_pos": 0,
"exit_pos": 0,
"total_pos": 0,
"quantity": 200,
"price": 0.000026,
"sl_price": 0.00005005,
"target_price": 0,
"stop_price": 0,
"pnl": 0,
"initial_margin": 0,
"interest": 0.05,
"interest_amount": 0,
"leverage": 1,
"result": null,
"created_at": 1568122929782,
"updated_at": 1568122930404,
"orders": [{
"id": 164993,
"order_type": "limit_order",
"status": "rejected",
"market": "XRPBTC",
"side": "sell",
"avg_price": 0,
"total_quantity": 200,
"remaining_quantity": 200,
"price_per_unit": 0.000026,
"timestamp": 1568122929880.75,
"fee": 0.02,
"fee_amount": 0,
"filled_quantity": 0,
"bo_stage": "stage_entry",
"cancelled_quantity": 0,
"stop_price": 0
}]
},
{
"id": "e45cd26a-32e9-4d20-b230-a8933046f4eb",
"side": "sell",
"status": "rejected",
"market": "XRPBTC",
"order_type": "limit_order",
"trailing_sl": false,

75/192
 "trail_percent": null,
"avg_entry": 0,
"avg_exit": 0,
"fee": 0.02,
"entry_fee": 0,
"exit_fee": 0,
"active_pos": 0,
"exit_pos": 0,
"total_pos": 0,
"quantity": 200,
"price": 0.000026,
"sl_price": 0.00005005,
"target_price": 0,
"stop_price": 0,
"pnl": 0,
"initial_margin": 0,
"interest": 0.05,
"interest_amount": 0,
"leverage": 1,
"result": null,
"created_at": 1568122721421,
"updated_at": 1568122721905,
"orders": [{
"id": 164993,
"order_type": "limit_order",
"status": "rejected",
"market": "XRPBTC",
"side": "sell",
"avg_price": 0,
"total_quantity": 200,
"remaining_quantity": 200,
"price_per_unit": 0.000026,
"timestamp": 1568122929880.75,
"fee": 0.02,
"fee_amount": 0,
"filled_quantity": 0,
"bo_stage": "stage_entry",
"cancelled_quantity": 0,
"stop_price": 0
}]
}
]

Use this endpoint to fetch orders and optionally its details which include all buy/sell
related orders

HTTP Request
POST /exchange/v1/margin/fetch_orders

Parameters

76/192
Name Type Required Example Description

market string No XRPBTC The trading

pair, default:
Orders for all
market

details boolean No false Whether you

want detailed
information or
not, default:
false

status string No The status of

init,open,close,rejected,cancelled, the order,
default: All
partial_entry,partial_close,triggered orders

size number No 20 Number of

records per
page, default:
10

timestamp number Yes 1524211224 Timestamp at

which the
request was
generated (see
'Common
Notes' under
'Authentication'
heading to
read more)

Query Order

77/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp.
timeStamp = int(round(time.time() * 1000))

body = {
"details": true,
"id": "30b5002f-d9c1-413d-8a8d-0fd32b054c9c",
"timestamp": timeStamp
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/margin/order"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response:

78/192
[{
"id": "30b5002f-d9c1-413d-8a8d-0fd32b054c9c",
"side": "sell",
"status": "rejected",
"market": "XRPBTC",
"order_type": "limit_order",
"trailing_sl": false,
"trail_percent": null,
"avg_entry": 0,
"avg_exit": 0,
"fee": 0.02,
"entry_fee": 0,
"exit_fee": 0,
"active_pos": 0,
"exit_pos": 0,
"total_pos": 0,
"quantity": 200,
"price": 0.000026,
"sl_price": 0.00005005,
"target_price": 0,
"stop_price": 0,
"pnl": 0,
"initial_margin": 0,
"interest": 0.05,
"interest_amount": 0,
"leverage": 1,
"result": null,
"created_at": 1568122929782,
"updated_at": 1568122930404,
"orders": [{
"id": 164993,
"order_type": "limit_order",
"status": "rejected",
"market": "XRPBTC",
"side": "sell",
"avg_price": 0,
"total_quantity": 200,
"remaining_quantity": 200,
"price_per_unit": 0.000026,
"timestamp": 1568122929880.75,
"fee": 0.02,
"fee_amount": 0,
"filled_quantity": 0,
"bo_stage": "stage_entry",
"cancelled_quantity": 0,
"stop_price": 0
}]
}
]

Use this endpoint to query specific order and optionally its details.

HTTP Request

79/192
POST /exchange/v1/margin/order

Parameters

Name Type Required Example Description

id string Yes 30b5002f- Id of the order

d9c1-413d-
8a8d-
0fd32b054c9c

details boolean No false Whether you want detailed

information or not, default: false

timestamp number Yes 1524211224 Timestamp at which the request

was generated (see 'Common
Notes' under 'Authentication'
heading to read more)

Pagination
Get the pagination details in the response header

Parameters

Name Description

page Page number to fetch. Pagination starts at page 1

size Number of records per page; Default: 100, Max: 1000

Response Headers

Spot Sockets
There are two types of channels

1. Private (requires authentication)

2. Public (doesn’t require authentication)

PUBLIC

To connect to public socket

Refer to the right panel.

Below chart states the channel to event flow

80/192
81/192
import socketio

def my_headers():
return {"origin": "*"}

socketEndpoint = 'https://stream.coindcx.com'
sio = socketio.Client()

sio.connect(socketEndpoint, transports = 'websocket')

# Listen update on channelName

@sio.on('channelName')
def on_message(response):
print(response.data)

# leave a channel
sio.emit('leave', { 'channelName' : channelName })

# Successfull connection
@sio.event
def connect():
sio.emit('join', { 'channelName': 'channelName' })
print("I'm connected!")

# Connection error
@sio.event
def connect_error(data):
print("The connection failed!")

Get Balance Update

Definitions

Channel: coindcx (Private).

Event: balance-update
Description: This Event gives the wallet balance information whenever there is a
change in wallet balance

Response

id: Wallet Id
balance: usable balance
locked_balance: balance currently being used by an open order
currency_short_name: currency like LTC, BTC etc.

82/192
import socketio
import hmac
import hashlib
import json

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

key = "xxx"
secret = "xxx"

secret_bytes = bytes(secret, encoding='utf-8')

channelName = "coindcx"
body = {"channel": channelName}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': channelName, 'authSignature': signature,
'apiKey': key})

@sio.on('balance-update')
def on_message(response):
print("balance-update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('balance-update', {'channelName': channelName})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Balance Update response:

[
{
"id":"102a7916-a622-11ee-bd36-479d3cf6751b",
"balance":"265.01745775027309",
"locked_balance":"258.600771",
"currency_id":"cfe01e2a-f1af-4e52-9696-9a19d9a8eb4f",
"currency_short_name":"INR"
}
]

83/192
Get Order Update

Definitions

Channel: coindcx (Private).

Event: order-update
Description: This Event gives the order info whenever there is a change in order
status

Response

id: unique order identifier (uuid)

client_order_id: client order id of the order
order_type: the order type
side: whether the order is a buy order or a sell order
status: the current status
fee_amount: total fee amount charged so far (in base-currency)
fee: deprecated - do not refer - will be removed soon
maker_fee: the fee (in percentage) to be charged for maker-trades for this order
taker_fee: the fee (in percentage) to be charged for taker-trades for this order
total_quantity: total quantity
remaining_quantity: pending (unfilled/uncancelled) quantity
source: deprecated - do not refer - will be removed soon
base_currency_name: deprecated - do not refer - will be removed soon
target_currency_name: deprecated - do not refer - will be removed soon
base_currency_short_name: deprecated - do not refer - will be removed soon
target_currency_short_name: deprecated - do not refer - will be removed soon
base_currency_precision: deprecated - do not refer - will be removed soon
target_currency_precision: deprecated - do not refer - will be removed soon
avg_price: avg-execution price so far
price_per_unit: specified limit price
stop_price: specified stop price (applicable for stop-variant orders)
market: symbol
time_in_force: just contains one value for now, which is good_till_cancel
created_at: the timestamp for order creation
updated_at: the latest timestamp specifying when the order was updated

84/192
import socketio
import hmac
import hashlib
import json

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

key = "xxx"
secret = "xxx"

secret_bytes = bytes(secret, encoding='utf-8')

channelName = "coindcx"
body = {"channel": channelName}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': channelName, 'authSignature': signature,
'apiKey': key})

@sio.on('order-update')
def on_message(response):
print("order-update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('order-update', {'channelName': channelName})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Order Update response:

85/192
[
{
"id":"f6b68656-091c-11ef-92dc-67ec5900cddc",
"client_order_id":null,
"order_type":"market_order",
"side":"buy",
"status":"filled",
"fee_amount":1.286714,
"fee":0.5,
"maker_fee":0.5,
"taker_fee":0.5,
"total_quantity":2.86,
"remaining_quantity":0,
"source":"web",
"base_currency_name":"Indian Rupee",
"target_currency_name":"Tether",
"base_currency_short_name":"INR",
"target_currency_short_name":"USDT",
"base_currency_precision":2,
"target_currency_precision":2,
"avg_price":89.98,
"price_per_unit":89.97,
"stop_price":0,
"market":"USDTINR",
"time_in_force":"good_till_cancel",
"created_at":1714720547465,
"updated_at":1714720547805
}
]

Get Trade Update

Definitions

Channel: coindcx (Private).

Event: trade-update
Description: This Event gives the trade info whenever trades are executed.

Response

o: system generated order id

c: client order id
t: trade id
s: symbol/market (USDTINR)
p: price
q: quantity
T: timestamp
m: whether the buyer is market maker or not.
f: fee amount

86/192
 e: exchange identifier
x: status

import socketio
import hmac
import hashlib
import json

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

key = "xxx"
secret = "xxx"

secret_bytes = bytes(secret, encoding='utf-8')

channelName = "coindcx"
body = {"channel": channelName}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': channelName, 'authSignature': signature,
'apiKey': key})

@sio.on('trade-update')
def on_message(response):
print("trade-update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('trade-update', {'channelName': channelName})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Trade Update response:

87/192
[
{
"o":"f6b68656-091c-11ef-92dc-67ec5900cddc",
"c":null,
"t":"108263519",
"s":"USDTINR",
"p":"89.98",
"q":"2.86",
"T":1714720547635.6172,
"m":false,
"f":"1.286714",
"e":"I",
"x":"filled"
}
]

Get Candlestick Info

The set of candlestick resolutions available are ["1m", "5m", "15m", "30m", "1h", "4h",
"8h", "1d", "3d", "1w", "1M"]. For example, for 15 minute candle please connect to channel
{pair}_15m.

Definitions

Channel: {pair}_1m ( Use 'pair' from Markets details API response. )

Event: candlestick
Description: This event provides information on the current candlestick bars for a
given pair at the resolution.

Response

t: start timestamp
T: close timestamp
s: symbol
i: candle period
f : first trade ID
L: last trade ID
o: open
c: close
h: high
l: low
v: Base asset volume
n: number of trades
x: current candle has been completed Y/N
q: completed trade amount (in quote asset)
V: Taker buy base asset volume
Q: taker trade amount(in quote asset)

88/192
 B: first trade ID
ecode: exchange code
channel: Channel Name
pr: product

import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "B-BTC_USDT_1m"})

@sio.on('candlestick')
def on_message(response):
print("candlestick Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('candlestick', {'channelName': "B-BTC_USDT_1m"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Candlestick response:

89/192
{
"t": 1717075560000,
"T": 1717075619999,
"s": "BTCUSDT",
"i": "1m",
"f": 3619173860,
"L": 3619175261,
"o": "68292.00000000",
"c": "68273.44000000",
"h": "68292.00000000",
"l": "68273.43000000",
"v": "10.37494000",
"n": 1402,
"x": false,
"q": "708461.81457520",
"V": "0.38858000",
"Q": "26534.68106390",
"B": "0",
"ecode": "B",
"channel": "B-BTC_USDT_1m",
"pr": "spot"
}

Get Depth Snapshot Info ( Order Book )

{pair}@orderbook@50, Here 50 denotes, the depth of the order book the other possible
values are 10 and 20.

Definitions
Channel: {pair}@orderbook@20 ( Use 'pair' from Markets details API response. )
Event: depth-snapshot
Description: This event gives the changes in the orderbook data of the pair as a
snapshot.

Response
vs: version
ts: timestamp
pr: product
s: symbol(currency)

90/192
import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "B-BTC_USDT@orderbook@20"})

@sio.on('depth-snapshot')
def on_message(response):
print("depth-snapshot Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('depth-snapshot', {'channelName': "B-
BTC_USDT@orderbook@20"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Depth Snapshot response:

91/192
{
"ts":1715885479864,
"vs":35623836,
"asks":{
"65110":"0.2561",
"65114":"0.0786",
"65109.99":"0.09215",
"65110.8":"0.00998",
"65110.91":"0.01037",
"65111.02":"0.00215",
"65111.24":"0.00461"
},
"bids":{
"65108":"0.0786",
"65109":"0.00008",
"65109.98":"12.5249",
"65109.84":"0.09215",
"65109.31":"0.00015",
"65109.29":"0.2"
},
"pr":"spot",
"s":"BTCUSDT"
}

Get Depth Update ( Order Book )

{pair}@orderbook@50, Here 50 denotes, the depth of the order book the other possible
values are 10 and 20.

Definitions
Channel: {pair}@orderbook@20 ( Use 'pair' from Markets details API response. )
Event: depth-update
Description: This Event gives the changes in the orderbook data of the pair when
the depth of the orderbook changes.

Response
vs: version
ts: timestamp
pr: product
E: Event time
s: symbol(currency)

92/192
import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "B-BTC_USDT@orderbook@20"})

@sio.on('depth-update')
def on_message(response):
print("depth-update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('depth-update', {'channelName': "B-BTC_USDT@orderbook@20"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Depth Snapshot response:

93/192
{
"ts":1714653301197,
"vs":10037615,
"asks":{
"0.10828":"260",
"0.10834":"9866.0606",
"0.1085":"23769.6456",
"0.10899":"347.2024",
"0.109":"133711.3629",
"0.10901":"32941.0265",
"0.10829":"0.0",
"0.10836":"0.0",
"0.10838":"0.0",
"0.10845":"0.0"
},
"bids":{
"0.10758":"38692.1224",
"0.10757":"23141",
"0.10747":"1731.4441",
"0.10736":"0.0"
},
"E":1714653301194,
"pr":"spot",
"s":"BTCUSDT"
}

Get Current Prices

currentPrices@spot@10s, Here 10 denotes, the interval at which the prices can be
fetched, the other possible value is 1s and 10s.

Definitions
Channel: currentPrices@spot@10s
Event: currentPrices@spot#update
Description: This Event gives the current prices of the pairs whose price got
updated in the last 1s/10s.

Response
vs: version
ts: timestamp
pr: product

94/192
import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "currentPrices@spot@10s"})

@sio.on('currentPrices@spot#update')
def on_message(response):
print("currentPrices@spot#update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('currentPrices@spot#update', {'channelName':
"currentPrices@spot@10s"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get Current Prices response:

{
"vs":6114777,
"ts":1714653300622,
"pr":"spot",
"prices":{
"XAUTUSDT":2307.77,
"INJUSDT":23.35,
"ONGUSDT":0.5334,
"MOVRUSDT":12.335,
"TRACUSDT":0.8529,
"HIFLUFUSDT":0.001513,
"BEAMXUSDT":0.0237,
"BABYUSDT":0.002283,
"SAOUSDT":0.002034,
"CVXUSDT":2.478
}
}

95/192
Get Price Stats
priceStats@spot@60s, Here 60 denotes, the interval at which the prices can be fetched.

Definitions

Channel: priceStats@spot@60s
Event: priceStats@spot#update
Description: This Event gives the 24hrs price change of pairs whose price got
updated in the last 60s.

Response
vs: version
ts: timestamp
pr: product
pc: price change percent
v: volume 24h

import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "priceStats@spot@60s"})

@sio.on('priceStats@spot#update')
def on_message(response):
print("priceStats@spot#update Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('priceStats@spot#update', {'channelName':
"priceStats@spot@60s"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

96/192
 Get Price Stat response:

{
"vs":1006039,
"ts":1716358680710,
"pr":"spot",
"stats":{
"HISAND33USDT":{
"v":4074970.9761
},
"ENSUSDT":{
"pc":3.48,
"v":103333815.5488
},
"DOTBTC":{
"v":16.52801718,
"pc":2.647
},
"ISLMUSDT":{
"v":10588293.415
}
}
}

Get New Trade

Definitions
Channel: {pair}@trades
Event: new-trade
Description: This Event gives the latest trade info of the given pair.

Response

m: whether the buyer is market maker or not

p: trade price
q: quantity
T: timestamp of trade
s: symbol(currency)

97/192
import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "B-BTC_USDT@trades"})

@sio.on('new-trade')
def on_message(response):
print("new-trade Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('new-trade', {'channelName': "B-BTC_USDT@trades"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get New Trade response:

{
"T":"1714653304357",
"p":"0.10804",
"q":"1050.4254",
"m":0,
"s":"B-BTC_USDT",
"pr":"spot"
}

Get Price Change ( LTP )

Definitions

Channel: {pair}@prices
Event: price-change
Description: This Event gives the latest price info of a pair whenever there is a
price change.

98/192
Response
p: trade price
T: timestamp of trade
pr: Product(spot)

import socketio

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

@sio.event
def connect():
print("I'm connected!")
sio.emit('join', {'channelName': "B-BTC_USDT@prices"})

@sio.on('price-change')
def on_message(response):
print("price-change Response !!!")
print(response)

def main():
try:
sio.connect(socketEndpoint, transports='websocket')
while True:
sio.event('price-change', {'channelName': "B-BTC_USDT@prices"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise

# Run the main function

if __name__ == '__main__':
main()

Get New Trade response:

{
"T":"1714653304357",
"p":"0.10804",
"pr":"spot"
}

Sample code for Socket Connection

Note

Websocket connection implementation with ping check : Ping check is required to

keep the socket connection alive.

99/192
Only Private channels need authentication.
Python Packages Required : python-socketio[client]
APPLE MAC Issue : Certificate verify failed: unable to get local issuer certificate or
Mac OSX python ssl.SSLError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate
verify failed (_ssl.c:749) -> Fix for the issue : Will be fixed by installing the
"Install Certificates.command"

100/192
import socketio
import hmac
import hashlib
import json
import time
import asyncio
from datetime import datetime

socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.AsyncClient(logger=True, engineio_logger=True)

key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
channelName = "coindcx"
body = {"channel": channelName}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

async def ping_task():

while True:
await asyncio.sleep(25)
try:
await sio.emit('ping', {'data': 'Ping message'})
except Exception as e:
print(f"Error sending ping: {e}")

@sio.event
async def connect():
print("I'm connected!")
# Get the current time
current_time = datetime.now()

# Format and print the current time

print("Connected Time:", current_time.strftime("%Y-%m-%d %H:%M:%S"))
await sio.emit('join', {'channelName': "coindcx", 'authSignature': signature,
'apiKey': key})

@sio.on('balance-update')
async def on_message(response):
# Get the current time
current_time = datetime.now()

# Format and print the current time

print("balance-update Change Time:", current_time.strftime("%Y-%m-%d
%H:%M:%S"))
print("balance-update Change Response !!!")
print(response)

101/192
async def main():
try:
await sio.connect(socketEndpoint, transports='websocket')
# Wait for the connection to be established
asyncio.create_task(ping_task())

await sio.wait()
while True:
time.sleep(1)
sio.event('balance-update', {'channelName': "coindcx"})

except Exception as e:
print(f"Error connecting to the server: {e}")
raise # re-raise the exception to see the full traceback

# Run the main function

if __name__ == '__main__':
asyncio.run(main())

Response:

Futures End Points

Glossary
e - is the Event type
p - price (LTP)
q - quantity (trade quantity)
pr - product (futures)
f - futures
s - spot
T - timestamp
m - is maker. Boolean value that would be true if its maker and false if its taker
RT - range timestamp
ts - timestamp
vs - version
Ets - event timestamp as given by TPE (applicable to candlesticks data)
i - Interval
E - event timestamp (applicable to order book data)
pST - price sent time
v - volume 24h
ls - last price
pc - price change percent
btST - TPE Tick send time
mp - mark price

102/192
 bmST - TPE mark price send time (The timestamp at which Third-Party exchange
sent this event)

Get active instruments

Use this endpoint to fetch the list of all active Futures instruments.

HTTP Request
GET
https://api.coindcx.com/exchange/v1/derivatives/futures/data/active_instrum
ents?margin_currency_short_name[]={futures_margin_mode}

import json

import requests # Install requests module first.

# Use this url to get the USDT active instruments

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/data/active_instruments?
margin_currency_short_name[]=USDT"

# Use this url to get the INR active instruments

#url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/data/active_instruments?
margin_currency_short_name[]=INR"

response = requests.get(url)
data = response.json()
print(json.dumps(data, indent=2))

Response

[
"B-VANRY_USDT",
"B-BOME_USDT",
"B-BTCDOM_USDT",
"B-IOTX_USDT",
"B-LPT_USDT",
"B-ENA_USDT",
"B-GMT_USDT",
"B-APE_USDT",
"B-WOO_USDT",
"B-ASTR_USDT",
"B-GMX_USDT",
"B-TLM_USDT",
]

Get instrument details

Use this endpoint to fetch the all the details of the instrument

103/192
HTTP Request
GET
https://api.coindcx.com/exchange/v1/derivatives/futures/data/instrument?
pair={instrument}&margin_currency_short_name={futures_margin_mode}

Response Defnitions

Key Description

settle_currency_short_name Currency in which you buy/sell futures contracts

quote_currency_short_name Currency in which you see the price of the futures

contract

position_currency_short_name Underlying crypto on which the futures contract is

created

underlying_currency_short_name Underlying crypto on which the futures contract is

created

status Status of the instrument. Possible values are

“active“ and “inactive“.

pair Instrument Pair name. This is the format in which

the input of the pairs will be given in any API
request.

kind CoinDCX only supports perpetual contracts for

now, so this value will always be “perpetual”

settlement This will be the settlement date of the contract. It

will be “never” for perpetual contracts

max_leverage_long Ignore this

max_leverage_short Ignore this

unit_contract_value This will be equal to 1 for all the Perpetual futures

price_increment If price increment is 0.1 then price inputs for limit

order can be x, x+0.1, x+0.1*2, x+0.1*3, etc

quantity_increment If qty increment is 0.1 then qty inputs for an order

can be x, x+0.1, x+0.1*2, x+0.1*3, etc

min_trade_size This is the minimum quantity of a trade that can

be settled on exchange.

min_price Minimum amount to enter the position

max_price Maximum amount to enter the position

min_quantity Minimum quantity to enter the position

104/192
max_quantity Maximum quantity to enter the position

min_notional Minimum value you can purchase for a symbol

maker_fee Maker fees mean when you add liquidity to the

market by placing a new order that isn’t
immediately matched.

taker_fee Taker fees mean when you remove liquidity by

filling an existing order.

safety_percentage Ignore this

quanto_to_settle_multiplier Ignore this. This will be equal to 1

is_inverse Ignore this. This will be false

is_quanto Ignore this. This will be false

allow_post_only Ignore this

allow_hidden Ignore this

max_market_order_quantity This gives the maximum allowed quantity in a

market order

funding_frequency Number of hours after which funding happens. If

the value is 8 that means the funding happens
every 8 hours.

max_notional Ignore this

exit_only If this is true then you can’t place fresh orders to

take a new position or add more to an existing
position. Although you can reduce your existing
positions and cancel your open orders. If you
already have open orders to add positions, they
will not be impacted.

multiplier_up This denotes how aggressive your limit buy

orders can be placed compared to LTP. For
example if the LTP is 100 and you want to place a
buy order. The limit price has to be between
minPrice and LTP*(1+multiplierUp/100)

multiplier_down This denotes how aggressive your limit sell

orders can be placed compared to LTP. For
example if the LTP is 100 and you want to place a
sell order. The limit price has to be between
maxPrice and LTP*(1-multiplierDown/100)

liquidation_fee This denotes Applicable fee if the trade received

for the order is a trade for the liquidation order

105/192
 dynamic_position_leverage_details Sample response: { "5":15000000.0,
"8":5000000.0, "10":1000000.0, "15":500000.0,
"20":100000.0, "25":50000.0 } This gives you the
max allowed leverage for a given position size.
So for example if your positions size is 120K
which is higher than 100K and less than 500K
USDT, then max allowed leverage is 15x

dynamic_safety_margin_details Sample response: { "50000":1.5, "100000":2.0,

"500000":3.0, "1000000":5.0, "5000000":6.0,
"15000000":10.0 } This gives you the calculation
for maintenance margin of the position. In the
above example, if you have a position size of 60K
USDT, then your maintenance margin will be
50K*1.5% + 10K*2% = 950 USDT.Your position
will be liquidated when the margin available in
your position goes below 950 USDT. Liquidation
price is calculated using this number and will be
updated in the get position endpoint

expiry_time Ignore this

time_in_force_options Time in force indicates how long your order will

remain active before it is executed or expired.
Possible values are good_till_cancel,
immediate_or_cancel, fill_or_kill

margin_currency_short_name Futures margin mode

import requests # Install requests module first.

# Use this url to get the INR active instrument info

#url = "https://api.coindcx.com/exchange/v1/derivatives/futures/data/instrument?
pair=B-BTC_USDT&margin_currency_short_name=INR"

# Use this url to get the USDT active instrument info

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/data/instrument?
pair=B-BTC_USDT&margin_currency_short_name=USDT"
response = requests.get(url)
data = response.json()
print(data)

Response

106/192
{
"instrument":{
"settle_currency_short_name":"USDT",
"quote_currency_short_name":"USDT",
"position_currency_short_name":"AAVE",
"underlying_currency_short_name":"AAVE",
"status":"active",
"pair":"B-AAVE_USDT",
"kind":"perpetual",
"settlement":"never",
"max_leverage_long":10.0,
"max_leverage_short":10.0,
"unit_contract_value":1.0,
"price_increment":0.01,
"quantity_increment":0.1,
"min_trade_size":0.1,
"min_price":4.557,
"max_price":2878.2,
"min_quantity":0.1,
"max_quantity":950000.0,
"min_notional":6.0,
"maker_fee":0.025,
"taker_fee":0.075,
"safety_percentage":2.0,
"quanto_to_settle_multiplier":1.0,
"is_inverse":false,
"is_quanto":false,
"allow_post_only":false,
"allow_hidden":false,
"max_market_order_quantity":1250.0,
"funding_frequency":8,
"max_notional":320000.0,
"expiry_time":2548162800000,
"exit_only":false,
"multiplier_up":8.0,
"multiplier_down":8.0,
"liquidation_fee": 1.0,
"margin_currency_short_name": "USDT",
"time_in_force_options":[
"good_till_cancel",
"immediate_or_cancel",
"fill_or_kill"
],
"order_types":[
"market_order",
"limit_order",
"stop_limit",
"take_profit_limit",
"stop_market",
"take_profit_market"
],
"dynamic_position_leverage_details":{
"5":15000000.0,
"8":5000000.0,
"10":1000000.0,

107/192
 "15":500000.0,
"20":100000.0,
"25":50000.0
},
"dynamic_safety_margin_details":{
"50000":1.5,
"100000":2.0,
"500000":3.0,
"1000000":5.0,
"5000000":6.0,
"15000000":10.0
}
}
}

Get instrument Real-time trade history

Use this endpoint to fetch the real time trade history details of the instrument.While rest
APIs exist for this, we recommend using Futures Websockets

HTTP Request
GET https://api.coindcx.com/exchange/v1/derivatives/futures/data/trades?
pair={instrument_name}

Response Defnitions

KEY DESCRIPTION

price Price of the trade update

quantity Quantity of the trade update

timestamp EPOCH timestamp of the event

is_maker If the trade is maker then this value will be “true”

import requests # Install requests module first.

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/data/trades?pair=
{instrument_name}"
#sample_url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/data/trades?pair=B-
MKR_USDT"
response = requests.get(url)
data = response.json()
print(data)

Response

108/192
[
{
"price": 1.1702,
"quantity": 22000,
"timestamp": 1675037938736,
"is_maker": true
},
{
"price": 1.1702,
"quantity": 38000,
"timestamp": 1675037950130,
"is_maker": true
}
]

Get instrument orderbook

Use this endpoint to fetch the depth of the order book details of the instrument.While rest
APIs exist for this, we recommend using Futures Websockets Here 50 denotes, the depth
of the order book the other possible values are 10 and 20

HTTP Request
GET https://public.coindcx.com/market_data/v3/orderbook/{instrument}-
futures/50

Response Defnitions

KEY DESCRIPTION

ts Epoch timestamp

vs Version

asks List of ask price and quantity

bids List of bid price and quantity

import requests # Install requests module first.

url = "https://public.coindcx.com/market_data/v3/orderbook/{instrument}-
futures/50"
#sample_url = "public.coindcx.com/market_data/v3/orderbook/B-MKR_USDT-futures/50"
#Here 50 denotes, the depth of the order book the other possible values are 10 and
20
response = requests.get(url)
data = response.json()
print(data)

Response

109/192
{
"ts": 1705483019891,
"vs": 27570132,
"asks": {
"2001": "2.145",
"2002": "4.453",
"2003": "2.997"
},
"bids": {
"1995": "2.618",
"1996": "1.55"
}
}

Get instrument candlesticks

Use this endpoint to fetch the candlestick bars for a symbol. Klines are uniquely identified
by their open time of the instrument.While rest APIs exist for this, we recommend using
Futures Websockets

HTTP Request
GET https://public.coindcx.com/market_data/candlesticks?pair={pair}&from=
{from}&to={to}&resolution={resolution}&pcode=f

Request Defnitions

Name Type Mandatory Description

pair String YES Name of the pair

from Integer YES EPOCH start timestamp of the required candlestick

in seconds

to Integer YES EPOCH end timestamp of the required candlestick

in seconds

resolution String YES '1' OR '5' OR '60' OR '1D' for 1min, 5min, 1hour,
1day respectively

pcode String YES Static value “f” to be used here. It denotes product =
futures

Response Defnitions

KEY DESCRIPTION

s status

open The first recorded trading price of the pair within that particular timeframe.

110/192
 high The highest recorded trading price of the pair within that particular timeframe.

low The lowest recorded trading price of the pair within that particular timeframe.

volume Total volume in terms of the quantity of the pair.

close The last recorded trading price of the pair within that particular timeframe.

time EPOCH timestamp of the open time.

import requests
url = "https://public.coindcx.com/market_data/candlesticks"
query_params = {
"pair": "B-MKR_USDT",
"from": 1704100940,
"to": 1705483340,
"resolution": "1D", # '1' OR '5' OR '60' OR '1D'
"pcode": "f"
}
response = requests.get(url, params=query_params)
if response.status_code == 200:
data = response.json()
# Process the data as needed
print(data)
else:
print(f"Error: {response.status_code}, {response.text}")

Response

{
"s":"ok",
"data":[
{
"open":1654.2,
"high":1933.5,
"low":1616.5,
"volume":114433.544,
"close":1831.9,
"time":1704153600000
},
{
"open":1832.2,
"high":1961,
"low":1438,
"volume":158441.387,
"close":1807.6,
"time":1704240000000
}
]
}

List Orders
111/192
Use this endpoint to fetch the list of orders based on the status ( open,filled,cancelled )
and side ( buy OR sell )

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/orders

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

status string YES Comma separated statuses as

open, filled, partially_filled,
partially_cancelled, cancelled,
rejected, untriggered

side string YES buy OR sell

page string YES Required page number

size string YES Number of records needed per

page

margin_currency_short_name Array OPTIONAL Futures margin mode.

Default value - ["USDT"].
Possible values INR & USDT.

Response Defnitions
Note : fee_amount and ideal_margin values are in USDT for INR Futures.

KEY DESCRIPTION

id Order id

pair Instrument Pair (Format: B-ETH_USDT)

side Order side. Possible values are buy or sell

112/192
status Order status. Possible values are:
OPEN - The order has been accepted
and is in open status
PARTIALLY_FILLED - Order which is
partially filled and the remaining quantity
is open
FILLED - The order has been
completely filled
CANCELED - The order has been
canceled
PARTIALLY_CANCELED - Order which
is partially filled and the remaining
quantity has been cancelled
REJECTED - The order was not
accepted by the system
UNTRIGGERED - TP or SL orders
which are not triggered yet

order_type Order type. Possible values are:

limit - A type of order where the
execution price will be no worse than the
order's set price. The execution price is
limited to be the set price or better.
market - A type of order where the user
buys or sells an asset at the best
available prices and liquidity until the
order is fully filled or the order book's
liquidity is exhausted.
stop_market - Once the market price hits
the stopPrice, a market order is placed
on the order book.
stop_limit - Once the market price hits
the stopPrice, a limit order is placed on
the order book at the limit price.
take_profit_market - Once the market
price hits the stopPrice, a market order
is placed on the order book.
take_profit_limit - Once the market price
hits the stopPrice, a limit order is placed
on the order book at the limit price.

stop_trigger_instruction Ignore this

notification Possible options: no_notification,

email_notification. Email notification will send
email notification once the order is filled.

leverage This is the leverage at which the order was

placed

maker_fee Fee charged when the order is executed as

maker

113/192
taker_fee Fee charged when the order is executed as
taker

fee_amount Amount of fee charged on an order. This

shows the fee charged only for the executed
part of the order

price Limit price at which the limit order was placed.

For market order, this will be the market price
at the time when the market order was placed

stop_price Trigger price of take profit or stop loss order

avg_price Average execution price of the order on the

exchange. It can be different compared to
“price” due to liquidity in the order books

total_quantity Total quantity of the order placed

remaining_quantity Remaining quantity of the order which is still

open and can be executed in the future

cancelled_quantity Quantity of the order which is cancelled and

will not be executed

ideal_margin Ignore this

order_category Ignore this

stage default - Standard limit, market, stop

limit, stop market, take profit limit, or
take profit market order
exit - Quick exit which closes the entire
position
liquidate - Order which was created by
the system to liquidate a futures position
tpsl_exit - Take profit or stop loss order
which was placed to close the entire
futures position

group_id Group id used when a large order is split into

smaller parts. All split parts will have the same
group id

liquidation_fee Applicable fee if the trade received for the

order is a trade for the liquidation order

position_margin_type “crossed” if the order was placed for cross

margin position. “Isolated” if the order is
placed for isolated margin position. Please
consider NULL also as isolated.

display_message Ignore this

group_status Ignore this

114/192
 created_at Timestamp at which the order was created

margin_currency_short_name Futures margin mode

settlement_currency_conversion_price USDT <> INR conversion price for the order.

This is relevant only for INR margined Orders.

updated_at Last updated timestamp of the order

import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp , # EPOCH timestamp in seconds
"status": "open", # Comma separated statuses as open,filled,cancelled
"side": "buy", # buy OR sell
"page": "1", #// no.of pages needed
"size": "10", #// no.of records needed
"margin_currency_short_name": ["INR", "USDT"]
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/orders"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

115/192
Response

116/192
[
{
"id":"714d2080-1fe3-4c6e-ba81-9d2ac9a46003",
"pair":"B-ETH_USDT",
"side":"buy",
"status":"open",
"order_type":"limit_order",
"stop_trigger_instruction":"last_price",
"notification":"no_notification",
"leverage":20.0,
"maker_fee":0.025,
"taker_fee":0.075,
"fee_amount":0.0,
"price":2037.69,
"stop_price":0.0,
"avg_price":0.0,
"total_quantity":0.019,
"remaining_quantity":0.019,
"cancelled_quantity":0.0,
"ideal_margin":1.93870920825,
"order_category":"None",
"stage":"default",
"group_id":"None",
"liquidation_fee": null,
"position_margin_type": "crossed",
"display_message":"ETH limit buy order placed!",
"group_status":"None",
"metatags": null,
"created_at":1705565256365,
"updated_at":1705565256940,
"margin_currency_short_name": "INR",
"settlement_currency_conversion_price": 89.0
},
{
"id":"ffb261ae-8010-4cec-b6e9-c111e0cc0c10",
"pair":"B-ID_USDT",
"side":"buy",
"status":"filled",
"order_type":"market_order",
"stop_trigger_instruction":"last_price",
"notification":"no_notification",
"leverage":10.0,
"maker_fee":0.025,
"taker_fee":0.075,
"fee_amount":0.011181375,
"price":0.3312,
"stop_price":0.0,
"avg_price":0.3313,
"total_quantity":45.0,
"remaining_quantity":0.0,
"cancelled_quantity":0.0,
"ideal_margin":1.4926356,
"order_category":"None",
"stage":"default",
"group_id":"None",

117/192
 "liquidation_fee": null,
"position_margin_type": "crossed",
"display_message":"ID market buy order filled!",
"group_status":"None",
"metatags": null,
"created_at":1705565061504,
"updated_at":1705565062462,
"margin_currency_short_name": "INR",
"settlement_currency_conversion_price": 89.0
}
]

Create Order
Use this endpoint to create an order by passing the necessary parameters.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/orders/create

NOTE

*** "Do not include 'time_in _force' parameter for market orders."

Buy Orders:
Stop Limit:
Stop price must be greater than LTP.
Limit price must be greater than stop price.
Take Profit Limit:
Stop price must be less than LTP.
Limit price must be greater than stop price and less than LTP.
Sell Orders:
Stop Limit:
Stop price must be less than LTP.
Limit price must be less than stop price.
Take Profit Limit:
Stop price must be greater than LTP.
Limit price must be less than stop price and greater than LTP.

Request Defnitions

Note : Cross margin mode is only supported on USDT margined Futures at the moment.

Name Type Mandatory Description

118/192
timestamp Integer YES Latest epoch timestamp when
the order is placed. Orders
with a delay of more than 10
seconds will be rejected.

side String YES buy OR sell

pair String YES Pair name (format: B-

ETH_USDT)

order_type String YES market, limit, stop_limit,

stop_market, take_profit_limit,
take_profit_market

price Integer YES Order Price (limit price for

limit, stop limit, and take profit
limit orders). Keep this NULL
for market orders.

stop_price Integer YES Stop Price (stop_limit,

stop_market, take_profit_limit,
take_profit_market orders).
stop_price is the trigger price
of the order.

total_quantity Integer YES Order total quantity

leverage Integer OPTIONAL This is the leverage at which

you want to take a position.
Should match the leverage of
the position. Preferably set
before placing the order to
avoid rejection.

notification String YES no_notification OR

email_notification. Set as
email_notification to receive
an email once the order is
filled.

time_in_force String OPTIONAL Possible values:

good_till_cancel, fill_or_kill,
immediate_or_cancel. Default
is good_till_cancel if not
provided. Should be null for
market orders.

hidden Boolean NO Ignore this (Not supported at

the moment)

post_only Boolean NO Ignore this (Not supported at

the moment)

119/192
margin_currency_short_name String OPTIONAL Futures margin mode.
Default value - "USDT".
Possible values INR & USDT.

position_margin_type String OPTIONAL isolated, crossed.

If position margin type is not
passed, it considers the
margin type of the position as
default.

Possible Error Codes

Status
Code Message Reason

422 Order leverage must be When the leverage specified for an order does
equal to position leverage not match the leverage of the current position.

422 Quantity for limit variant Total quantity for a limit order exceeds the
orders should be less than maximum allowed limit.
9500.0

422 Quantity for market variant Total quantity for a market order exceeds the
orders should be less than maximum allowed market order quantity.
9500.0

400 Price is out of permissible If limit price or stop price mentioned is out of
range range i.e. price > max_price || price < min_price
for the instrument

400 Please enter a value lower Price is greater than max limit price (i.e. ltp + ltp *
than x multiplier_up)

400 Please enter a value Price is lower than min limit price (i.e. ltp - ltp *
higher than x multiplier_down)

400 Price should be divisible Price isn't divisible by the tick size
by 0.01

422 Quantity should be greater Quantity isn't greater than min quantity
than y

400 Insufficient funds Wallet doesn't have sufficient funds for placing
the order

400 Minimum order value Order value must be greater than min notional
should be x USDT

400 Instrument is in exit-only

mode. You can’t add more
position.

120/192
Status
Code Message Reason

400 You've exceeded the max Current position size is greater than position size
allowed position of x threshold
USDT.

400 Order is exceeding the Position size + order value > position size
max allowed position of x threshold
USDT.

422 Price can't be empty for

limit_order Order

400 Trigger price should be buy order, trigger_price < current price
greater than the current
price

400 Limit price should be buy limit order, limit price < trigger price
greater than the trigger
price

400 Trigger price should be sell order, trigger price > current price
less than the current price

400 Limit price should be less sell order, limit price < trigger price
than the trigger price

500 Invalid input

Response Defnitions

KEY DESCRIPTION

id Order id

pair Name of the futures pair

side Side: buy / sell

status Ignore this (It will be initial for all the newly
placed orders)

121/192
order_type Order type. Possible values are :
limit - a type of order where the
execution price will be no worse than the
order's set price. The execution price is
limited to be the set price or better.
market - A type of order where the user
buys or sells an asset at the best
available prices and liquidity until the
order is fully filled or the order book's
liquidity is exhausted.
stop_market - once the market price hits
the stopPrice, a market order is placed
on the order book.
stop_limit - once the market price hits
the stopPrice, a limit order is placed on
the order book at the limit price.
take_profit_market - once the market
price hits the stopPrice, a market order
is placed on the order book.
take_profit_limit - once the market price
hits the stopPrice, a limit order is placed
on the order book at the limit price.

notification no_notification OR email_notification If

property is set as email_notification then you
will get an email once the order is filled

leverage This is the leverage at which you want to take

a position. This has to be the same as the
leverage of the position. Else the order will be
rejected. You should preferably set the
leverage before placing the order to avoid
order rejection. Leverage needs to be set only
once post which it will be saved in the system
for that particular pair.

maker_fee Applicable fee if the trade received for the

order is a maker trade

taker_fee Applicable fee if the trade received for the

order is a taker trade

fee_amount This will be the fee that has been charged for
the user till now. As soon as the order is
placed, this value will be zero until you start
receiving trades for the order

price Order Price (limit price for limit, stop limit and
take profit limit orders) Keep this NULL for
market orders. Else the order will be rejected.

avg_price It will be zero for the newly placed orders. You

can check the latest fill price from the list
orders endpoint.

122/192
total_quantity Total quantity of the order

remaining_quantity Remaining quantity of the order that is still

open on the exchange and can get filled

cancelled_quantity Quantity of the order that is canceled and

won’t be filled

ideal_margin Ignore this

order_category Ignore this

stage default - Standard limit, market, stop limit, stop

market, take profit limit or take profit market
order exit - Quick exit which closes the entire
position liquidate - Order which was created
by the system to liquidate a futures position
tpsl_exit - Take profit or stop loss order which
was placed to close the entire futures position

group_id Group id is an id which is used whenever a

large order is split into smaller parts.System
auto-splits the market variant orders like quick
exit order, liquidate order and tpsl_exit order
into smaller parts if the order size is huge. All
the split parts will have the same group id

liquidation_fee Applicable fee if the trade received for the

order is a trade for the liquidation order

position_margin_type “crossed” if the order was placed for cross

margin position. “Isolated” if the order is
placed for isolated margin position. Please
consider NULL also as isolated.

display_message Ignore this

group_status Ignore this

created_at Timestamp at which the order was created

margin_currency_short_name Futures margin mode

settlement_currency_conversion_price USDT <> INR conversion price when the

order is placed. This is relevant only for INR
margined Orders.

updated_at Last updated timestamp of the order

123/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp":timeStamp , # EPOCH timestamp in seconds
"order": {
"side": "sell", # buy OR sell
"pair": "B-ID_USDT", # instrument.string
"order_type": "market_order", # market_order OR limit_order
"price": "0.2962", #numeric value
"stop_price": "0.2962", #numeric value
"total_quantity": 33, #numerice value
"leverage": 10, #numerice value
"notification": "email_notification", # no_notification OR
email_notification OR push_notification
"time_in_force": "good_till_cancel", # good_till_cancel OR fill_or_kill OR
immediate_or_cancel
"hidden": False, # True or False
"post_only": False # True or False
}
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/orders/create"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

124/192
 Response

[
{
"id":"c87ca633-6218-44ea-900b-e86981358cbd",
"pair":"B-ID_USDT",
"side":"sell",
"status":"initial",
"order_type":"market_order",
"notification":"email_notification",
"leverage":10.0,
"maker_fee":0.025,
"taker_fee":0.075,
"fee_amount":0.0,
"price":0.2966,
"avg_price":0.0,
"total_quantity":33.0,
"remaining_quantity":33.0,
"cancelled_quantity":0.0,
"ideal_margin":0.98024817,
"order_category":"None",
"stage":"default",
"group_id":"None",
"liquidation_fee": null,
"position_margin_type": "crossed",
"display_message":"None",
"group_status":"None",
"margin_currency_short_name" : "INR",
"settlement_currency_conversion_price": 89.0,
"created_at":1705647376759,
"updated_at":1705647376759
}
]

Cancel Order
Use this endpoint to cancel an order by passing the order id.

HTTP Request
POST https://api.coindcx.com//exchange/v1/derivatives/futures/orders/cancel

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Order id

125/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp":timeStamp , # EPOCH timestamp in seconds
"id": "c87ca633-6218-44ea-900b-e86981358cbd" # order.id
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/orders/cancel"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

{
"message":"success",
"status":200,
"code":200
}

List Positions

126/192
Use this endpoint to fetch positions by passing timestamp.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/positions

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

page String YES Required page number

size String YES Number of records needed per

page

margin_currency_short_name Array OPTIONAL Futures margin mode.

Default value - ["USDT"].
Possible values INR & USDT.

Response Defnitions
Note : All the margin values are in USDT for INR Futures.

KEY DESCRIPTION

id Position id. This remains fixed for a particular pair.

For example, the position id of your B-ETH_USDT
position will remain the same over time.

pair Name of the futures pair

active_pos Quantity of the position in terms of underlying. For

example, if active_pos = 1 for B-ETH_USDT then you
hold 1 quantity ETH Futures contract. For short
positions, active_pos will be negative.

inactive_pos_buy Sum of the open quantities of the pending buy

orders.

inactive_pos_sell Sum of the open quantities of the pending sell orders.

avg_price Average entry price of the position.

liquidation_price Price at which the position will get liquidated. This is

applicable only for positions with isolated margin.
Ignore this for cross margined positions.

locked_margin Margin (in USDT) locked in the position after debiting

fees and adjusting funding from the initial investment.

127/192
locked_user_margin Margin (in USDT) that was initially invested in the
futures position excluding fees and funding.

locked_order_margin Total margin in USDT that is locked in the open

orders.

take_profit_trigger Trigger price set for Full Position take profit order.

stop_loss_trigger Trigger price set for Full position stop loss order.

leverage Leverage of the position.

maintenance_margin The amount of margin required to be maintained in

the account to avoid liquidation. For cross margined
positions, the maintenance margin required is equal
to the sum of the maintenance margins of all the
positions.

mark_price Mark price at the time when the position was last
updated. Note that this value is not real-time and is
only for reference purpose.

margin_type “crossed” if the order was placed for cross margin

position. “Isolated” if the order is placed for isolated
margin position. Please consider NULL also as
isolated.

settlement_currency_avg_price Average USDT <> INR conversion price for the

position. This is relevant only for INR margined
Positions.

margin_currency_short_name Futures margin mode

updated_at Timestamp when the position was last updated. It

could be due to trade update, funding, add/remove
margin, or changes in full position take profit/stop
loss orders.

128/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp":timeStamp , # EPOCH timestamp in seconds
"page": "1", #no. of pages needed
"size": "10",
"margin_currency_short_name": ["USDT"]
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/positions"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

129/192
[
{
"id": "571eae12-236a-11ef-b36f-83670ba609ec",
"pair": "B-BNB_USDT",
"active_pos": 0.0,
"inactive_pos_buy": 0.0,
"inactive_pos_sell": 0.0,
"avg_price": 0.0,
"liquidation_price": 0.0,
"locked_margin": 0.0,
"locked_user_margin": 0.0,
"locked_order_margin": 0.0,
"take_profit_trigger": null,
"stop_loss_trigger": null,
"leverage": 10.0,
"maintenance_margin": 0.0,
"mark_price": 0.0,
"margin_type": "crossed",
"settlement_currency_avg_price": 0.0,
"margin_currency_short_name": "USDT",
"updated_at": 1717754279737
}
]

Get Positions By pairs or positionid

Use this endpoint to fetch positions by passing either pairs or position id’s.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/positions

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

page String YES Required page number

size String YES Number of records needed per

page

pairs String OPTIONAL Instrument pair (can pass

multiple values with comma-
separated)

position_ids String OPTIONAL Position id’s (can pass multiple

values with comma-separated)

130/192
 margin_currency_short_name Array OPTIONAL Futures margin mode.
Default value - ["USDT"].
Possible values INR & USDT.

NOTE : Based on the requirement use the “ pairs “ or “ position_ids “ parameter. You
need to use either one of the 2 parameters

Response Defnitions

Note : All the margin values are in USDT for INR Futures.

KEY DESCRIPTION

id Position id. This remains fixed for a particular pair.

For example, the position id of your B-ETH_USDT
position will remain the same over time.

pair Name of the futures pair

active_pos Quantity of the position in terms of underlying. For

example, if active_pos = 1 for B-ETH_USDT then you
hold 1 quantity ETH Futures contract. For short
positions, active_pos will be negative.

inactive_pos_buy Sum of the open quantities of the pending buy

orders.

inactive_pos_sell Sum of the open quantities of the pending sell orders.

avg_price Average entry price of the position.

liquidation_price Price at which the position will get liquidated. This is

applicable only for positions with isolated margin.
Ignore this for cross margined positions.

locked_margin Margin (in USDT) locked in the position after debiting

fees and adjusting funding from the initial investment.

locked_user_margin Margin (in USDT) that was initially invested in the

futures position excluding fees and funding.

locked_order_margin Total margin in USDT that is locked in the open

orders.

take_profit_trigger Trigger price set for Full Position take profit order.

stop_loss_trigger Trigger price set for Full position stop loss order.

leverage Leverage of the position.

131/192
maintenance_margin The amount of margin required to be maintained in
the account to avoid liquidation. For cross margined
positions, the maintenance margin required is equal
to the sum of the maintenance margins of all the
positions.

mark_price Mark price at the time when the position was last
updated. Note that this value is not real-time and is
only for reference purpose.

margin_type “crossed” if the order was placed for cross margin

position. “Isolated” if the order is placed for isolated
margin position. Please consider NULL also as
isolated.

settlement_currency_avg_price Average USDT <> INR conversion price for the

position. This is relevant only for INR margined
Positions.

margin_currency_short_name Futures margin mode

updated_at Timestamp when the position was last updated. It

could be due to trade update, funding, add/remove
margin, or changes in full position take profit/stop
loss orders.

132/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"page": "1",
"size": "10",
"pairs": "B-BTC_USDT,B-ETH_USDT",
#"position_ids": "7830d2d6-0c3d-11ef-9b57-0fb0912383a7"
"margin_currency_short_name": ["USDT"]

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/positions"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(data)

Response

133/192
[
{
"id": "c7ae392e-5d70-4aaf-97dc-8e6b0076e391",
"pair": "B-BTC_USDT",
"active_pos": 0.0,
"inactive_pos_buy": 0.0,
"inactive_pos_sell": 0.0,
"avg_price": 0.0,
"liquidation_price": 0.0,
"locked_margin": 0.0,
"locked_user_margin": 0.0,
"locked_order_margin": 0.0,
"take_profit_trigger": 0.0,
"stop_loss_trigger": 0.0,
"leverage": null,
"maintenance_margin": null,
"mark_price": null,
"margin_type": "crossed",
"settlement_currency_avg_price": 0.0,
"margin_currency_short_name": "USDT",
"updated_at": 1709548678689
}
]

Update position leverage

Use this endpoint to update the leverage by passing either pair or position id.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/update_le
verage

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

leverage String YES leverage value

pair String OPTIONAL Instrument pair (can pass

multiple values with comma-
separated)

id String OPTIONAL Position id’s (can pass multiple

values with comma-separated)

margin_currency_short_name String YES Futures margin mode.

Default value - ["USDT"].
Possible values INR & USDT.

134/192
NOTE : Based on the requirement use the “ pairs “ or “ position_ids “ parameter. You
need to use either one of the 2 parameters

Possible Error Codes

Status
Code Message Reason

400 Leverage cannot be less than When leverage specified is less than the
1x minimum allowed leverage of 1x.

400 Max allowed leverage for User leverage exceeds the maximum allowed
current position size = 5x leverage based on tiered limits.

400 Insufficient funds Wallet doesn't have sufficient funds for

updating position or placing the order.

422 Liquidation will be triggered Condition where liquidation of the position will
instantly occur immediately.

135/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"leverage": "5", # leverage value
"pair": "B-LTC_USDT" # instrument.pair
#"id": "7830d2d6-0c3d-11ef-9b57-0fb0912383a7",
#"margin_currency_short_name": "INR"
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/update_leverage
"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(data)

Response

{
"message": "success",
"status": 200,
"code": 200
}

136/192
Add Margin
Use this endpoint to add the margin to the position.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/add_margi
n

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Position id

amount Integer YES Amount of margin to be added to the position.

Input will be in INR for INR margined futures and in
USDT for USDT margined futures. Adding margin
to the position makes your position safer by
updating its liquidation price.

137/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp , // EPOCH timestamp in seconds
"id": "434dc174-6503-4509-8b2b-71b325fe417a", // position.id
"amount":1
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/add_margin"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.post(url, data = json_body, headers = headers)
data = response.json()
print(data)

Response

{
"message":"success",
"status":200,
"code":200
}

138/192
Remove Margin
Use this endpoint to remove the margin for the position.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/remove_ma
rgin

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Position id

amount Integer YES Amount of margin to be removed from the position.

Input will be in INR for INR margined futures and in
USDT for USDT margined futures. Removing
margin increases the risk of your position
(liquidation price will get updated).

Possible Error Codes

Status
Code Message Reason

422 Cannot remove margin as exit Attempting to modify margin while an exit or
or liquidation is already in liquidation process is ongoing.
process

422 Cannot change margin for an Trying to adjust margin for a position that is
inactive position currently inactive.

422 Cannot remove margin more Attempting to reduce margin by an amount

than available in position greater than what is available in the
position.

422 Liquidation will be triggered Liquidation of the position will occur

instantly immediately due to specific conditions.

422 Max Y USDT can be removed Maximum amount of Y USDT can be

withdrawn from the position.

400 Insufficient funds Wallet doesn't have sufficient funds for the
requested action.

139/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp , # EPOCH timestamp in seconds
"id": "434dc174-6503-4509-8b2b-71b325fe417a", # position.id
"amount": 10
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/remove_margin"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

{
"message":"success",
"status":200,
"code":200
}

140/192
Cancel All Open Orders
Use this endpoint to cancel all the open orders till time.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cancel_al
l_open_orders

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

margin_currency_short_name Array OPTIONAL Futures margin mode.

Default value - ["USDT"].
Possible values INR & USDT.

141/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"margin_currency_short_name": ["USDT"],
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cancel_all_open
_orders"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

142/192
{
"message":"success",
"status":200,
"code":200
}

Cancel All Open Orders for Position

Use this endpoint to cancel all the open orders by passing the position id.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cancel_al
l_open_orders_for_position

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Position id

143/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp":timeStamp , # EPOCH timestamp in seconds
"id": "434dc174-6503-4509-8b2b-71b325fe417a" # position.id
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cancel_all_open
_orders_for_position"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

144/192
{
"message":"success",
"status":200,
"code":200
}

Exit Position
Use this endpoint to exit position by passing position id.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/positions/exit

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Position id

Response Defnitions

KEY DESCRIPTION

message

status

code

group_id Group id is an id which is used whenever a large order is split into smaller
parts. System auto-splits the exit order into smaller parts if the order size is
huge. All the split parts will have the same group id.

145/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp , # EPOCH timestamp in seconds
"id": "434dc174-6503-4509-8b2b-71b325fe417a" # position.id
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/positions/exit"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

146/192
{
"message":"success",
"status":200,
"code":200,
"data":{
"group_id":"baf926e6B-ID_USDT1705647709"
}
}

Create Take Profit and Stop Loss Orders

Use this endpoint to create the profit and stop loss order by passing necessary
parameters.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/create_tp
sl

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Position id

take_profit - String YES Stop price is the trigger price of the take
stop_price profit order

take_profit - String NO Limit price - Ignore this for now. This is not
limit_price supported.

take_profit - String YES Order type - Only “take_profit_market” is

order_type supported for now

stop_loss - String YES Stop price is the trigger price of the stop
stop_price loss order

stop_loss - String NO Limit price - Ignore this for now. This is not
limit_price supported.

stop_loss - String YES Order type - Only “stop_market” is

order_type supported for now

Response Defnitions

KEY DESCRIPTION

147/192
id

pair

side

status You’ll get this as "untriggered" for all the newly

placed orders. Use the list order endpoint to
track the status of the order. Large orders may
be split into smaller orders; in that case, the
group id can be used to track the statuses of
all the child orders at once.

order_type

stop_trigger_instruction Ignore this

notification

leverage

maker_fee

taker_fee

fee_amount

price

stop_price

avg_price

total_quantity

remaining_quantity

cancelled_quantity

ideal_margin

order_category

stage

group_id

display_message Ignore this

group_status Ignore this

margin_currency_short_name Position margin mode

settlement_currency_conversion_price USDT <> INR conversion price when the

order is placed

148/192
created_at

updated_at

success This will be false if a take profit (TP) or stop

loss (SL) creation fails

error Reason for failure

149/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"id": "e65e8b77-fe7c-40c3-ada1-b1d4ea40465f", # position.id
"take_profit": {
"stop_price": "1",
"limit_price": "0.9", # required for take_profit_limit orders
"order_type": "take_profit_limit" # take_profit_limit OR take_profit_market
},
"stop_loss": {
"stop_price": "0.271",
"limit_price": "0.270", # required for stop_limit orders
"order_type": "stop_limit" # stop_limit OR stop_market
}
}

json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/create_tpsl"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

150/192
 Response

{
"stop_loss":{
"id":"8f8ee959-36cb-4932-bf3c-5c4294f21fec",
"pair":"B-ID_USDT",
"side":"sell",
"status":"untriggered",
"order_type":"stop_limit",
"stop_trigger_instruction":"last_price",
"notification":"email_notification",
"leverage":1.0,
"maker_fee":0.025,
"taker_fee":0.075,
"fee_amount":0.0,
"price":0.27,
"stop_price":0.271,
"avg_price":0.0,
"total_quantity":0.0,
"remaining_quantity":0.0,
"cancelled_quantity":0.0,
"ideal_margin":0.0,
"order_category":"complete_tpsl",
"stage":"tpsl_exit",
"group_id":"None",
"display_message":"None",
"group_status":"None",
"margin_currency_short_name" : "INR",
"settlement_currency_conversion_price": 89.0,
"created_at":1705915027938,
"updated_at":1705915028003
},
"take_profit":{
"success":false,
"error":"TP already exists"
}
}

Get Transactions
Use this endpoint to get the list of transactions by passing the position ids and stage ( all
OR default )

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/transacti
ons

Request Defnitions

151/192
 Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

stage String YES Funding: Transactions created

due to funding
Default: Transactions created
for any order placed other than
quick exit and full position tpsl
Exit: Transactions created for
quick exit orders
Tpsl_exit: Transactions created
for full position tpsl_exit orders
Liquidation: Transactions
created for liquidation orders

page String YES Required page number

size String YES Number of records needed per

page

margin_currency_short_name Array OPTIONAL Futures margin mode.

Default value - ["USDT"].
Possible values INR & USDT.

Response Defnitions

Note : "amount", "fee_amount", "settlement_amount" will show in INR for INR margined
Futures and in USDT for USDT margined Futures.

KEY DESCRIPTION

pair

stage

amount This represents the PnL (Profit and Loss) from this
particular transaction.

fee_amount This represents the fee charged per transaction. A

transaction is created for every trade of the order.

price_in_inr Trade price in terms of INR.

price_in_btc Trade price in terms of BTC.

price_in_usdt Trade price in terms of USDT.

source Source will be “user” for the orders placed by the users
and will be “system” for the orders placed by the
system. Liquidation orders are placed by the system.

parent_type

152/192
 parent_id

position_id

settlement_amount Ignore this

margin_currency_short_name Futures margin mode

created_at

updated_at

import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
"stage": "all", # all OR default OR funding
"page": "1", #no. of pages needed
"size": "10" #no. of records needed
}
json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/transactions"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

153/192
 Response

[
{
"pair": "B-BTC_USDT",
"stage": "default",
"amount": 0.0,
"fee_amount": 8.899963104,
"price_in_inr": 1.0,
"price_in_btc": 1.85407055628e-07,
"price_in_usdt": 0.011572734637194769,
"source": "user",
"parent_type": "Derivatives::Futures::Order",
"parent_id": "061a7f36-daaf-4349-97c0-47bad7d08f5e",
"settlement_amount": 0.0,
"margin_currency_short_name": "INR",
"position_id": "beecde3c-7fe6-11ef-bd3a-5b8a901688d3",
"created_at": 1728459094499,
"updated_at": 1728459094499
}
]

Get Trades
Use this endpoint to all the trades information by passing the pair, order id and from and
to date.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/trades

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

pair String YES Name of the pair

order_id String OPTIONAL Order ID

from_date String YES Start date in format YYYY-MM-

DD

to_date String YES End date in format YYYY-MM-

DD

page String YES Required page number

size String YES Number of records needed per

page

154/192
 margin_currency_short_name Array YES Futures margin mode.
Default value - ["USDT"].
Possible values INR & USDT.

Response Defnitions
Note : fee_amount value is in USDT for INR Futures.

KEY DESCRIPTION

price

quantity

is_maker

fee_amount

pair

side

timestamp

order_id

settlement_currency_conversion_price USDT <> INR conversion price when the

order is placed

margin_currency_short_name Futures margin mode

155/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp":timeStamp, # EPOCH timestamp in seconds
"pair": "B-ID_USDT", # instrument.pair
"order_id": "9b37c924-d8cf-4a0b-8475-cc8a2b14b962", # order.id
"from_date": "2024-01-01", # format YYYY-MM-DD
"to_date": "2024-01-22", # format YYYY-MM-DD
"page": "1", #no. of pages needed
"size": "10" #no. of records needed
}
json_body = json.dumps(body, separators = (',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/trades"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data = json_body, headers = headers)

data = response.json()
print(data)

Response

156/192
[
{
"price":0.2962,
"quantity":33.0,
"is_maker":false,
"fee_amount":0.00733095,
"pair":"B-ID_USDT",
"side":"buy",
"timestamp":1705645534425.8374,
"order_id":"9b37c924-d8cf-4a0b-8475-cc8a2b14b962",
"settlement_currency_conversion_price": 0.0,
"margin_currency_short_name": "USDT"

}
]

Get Current Prices RT

Use this endpoint to get the current prices.

HTTP Request
GET https://public.coindcx.com/market_data/v3/current_prices/futures/rt

Response Defnitions

KEY DESCRIPTION

fr

h high

l low

v volume

ls

pc price change percent

mkt

btST TPE Tick send time

ctRT

skw

mp

efr

157/192
 bmST TPE mark price send time (The timestamp at which Third-Party exchange sent
this event)

cmRT

import requests # Install requests module first.

url = "https://public.coindcx.com/market_data/v3/current_prices/futures/rt"
response = requests.get(url)
data = response.json()
print(data)
print(json.dumps(data, indent=2))

Response

158/192
{
"ts": 1720429586580,
"vs": 54009972,
"prices": {
"B-NTRN_USDT": {
"fr": 5e-05,
"h": 0.4027,
"l": 0.3525,
"v": 18568384.9349,
"ls": 0.4012,
"pc": 4.834,
"mkt": "NTRNUSDT",
"btST": 1720429583629,
"ctRT": 1720429584517,
"skw": -207,
"mp": 0.40114525,
"efr": 5e-05,
"bmST": 1720429586000,
"cmRT": 1720429586117
},
"B-1000SHIB_USDT": {
"fr": -0.00011894,
"h": 0.017099,
"l": 0.014712,
"v": 358042914.374195,
"ls": 0.016909,
"pc": 2.578,
"mkt": "1000SHIBUSDT",
"btST": 1720429586359,
"ctRT": 1720429586517,
"skw": -207,
"mp": 0.01691261,
"efr": -9.115e-05,
"bmST": 1720429586000,
"cmRT": 1720429586117
}
}
}

Get Pair Stats

Use this endpoint to all the trades information by passing the pair.

HTTP Request
POST https://api.coindcx.com/api/v1/derivatives/futures/data/stats?pair=B-
ETH_USDT

Request Defnitions

159/192
Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

pair String YES Name of the pair

Response Defnitions

KEY DESCRIPTION

price_change_percent

high_and_low

1H Hour

1D Day

1W Week

1M Month

position

count_percent

long

short

value_percent

160/192
import hmac
import hashlib
import base64
import json
import time
import requests
# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"
# python3
secret_bytes = bytes(secret, encoding='utf-8')
# Generating a timestamp
timeStamp = int(round(time.time() * 1000))
body = {
"timestamp": timeStamp, # EPOCH timestamp in seconds
}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()
url = "https://api.coindcx.com/api/v1/derivatives/futures/data/stats?pair=B-
ETH_USDT"
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.get(url, data=json_body, headers=headers)
data = response.json()
print(json.dumps(data, indent=2))

Response

161/192
{
"price_change_percent": {
"1H": -0.15,
"1D": 1.41,
"1W": -11.95,
"1M": -17.34
},
"high_and_low": {
"1D": {
"h": 3098.0,
"l": 2821.26
},
"1W": {
"h": 3498.91,
"l": 2800.0
}
},
"position": {
"count_percent": {
"long": 93.2,
"short": 6.8
},
"value_percent": {
"long": 91.48,
"short": 8.52
}
}
}

Get Cross Margin Details

Use this endpoint to get the cross margin details
Note : Cross margin mode is not supported on INR margined Futures.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cross_mar
gin_details

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

Response Defnitions

KEY DESCRIPTION

162/192
pnl This is gives your unrealised PnL in cross
margin positions

maintenance_margin Cumulative maintenance margin of all the

cross margined positions

available_wallet_balance Ignore this

total_wallet_balance Total wallet balance excluding the PnL,

funding and fees of active positions

total_initial_margin Cumulative maintenance margin for cross

and isolated margined positions and orders

total_initial_margin_isolated Cumulative maintenance margin for isolated

margined positions and orders

total_initial_margin_crossed Cumulative maintenance margin for Cross

margined positions (Excluding orders)

total_open_order_initial_margin_crossed Cumulative initial margin locked for open

orders

available_balance_cross Balance available for trading in Cross

Margin mode

available_balance_isolated Balance available for trading in Isolated

Margin mode

margin_ratio_cross Margin ratio of the positions in cross margin

mode. Your Cross positions will get
liquidated if the ratio becomes greater than
equal to 1

withdrawable_balance Balance that can be withdrawn to spot

wallet from futures wallet

total_account_equity total_wallet_balance plus pnl

updated_at Ignore this

163/192
import hmac
import hashlib
import base64
import json
import time
import requests
# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"
# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)
# Generating a timestamp
timeStamp = int(round(time.time() * 1000))
body = {
"timestamp": timeStamp
}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()
url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/cross_margin_de
tails"
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.get(url, data=json_body, headers=headers)
data = response.json()
print(json.dumps(data, indent=2))

Response

{
"pnl": -0.0635144,
"maintenance_margin": 0.10170128,
"available_wallet_balance": 7.16966176,
"total_wallet_balance": 7.16966176,
"total_initial_margin": 0.68534648,
"total_initial_margin_isolated": 0.0,
"total_initial_margin_crossed": 0.68534648,
"total_open_order_initial_margin_crossed": 0.0,
"available_balance_cross": 6.42080088,
"available_balance_isolated": 6.42080088,
"margin_ratio_cross": 0.01431173,
"withdrawable_balance": 6.42080088,
"total_account_equity": 7.10614736,
"updated_at": 1720526407542
}

164/192
Wallet Transfer
Use this endpoint to transfer money from spot to futures wallet and vice-versa

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/wallets/transfer

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

transfer_type String YES "deposit" for depositing funds to futures

wallet "withdraw" for withdrawing funds
from future wallet

amount Integer YES Amount in terms of input currency

currency_short_name String YES “USDT” for transferring USDT, "INR" for

transferring INR

Response Defnitions

KEY DESCRIPTION

id Transaction id

currency_short_name Currency that was transferred

balance Ignore this

locked_balance Total initial margin locked in isolated margined orders and

positions

cross_order_margin Total initial margin locked in cross margined orders

cross_user_margin Total initial margin locked in cross margined positions

NOTE :
To calculate total wallet balance, use this formulae:
Total wallet balance = balance + locked_balance

165/192
import hmac
import hashlib
import base64
import json
import time
import requests
# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"
# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)
# Generating a timestamp
timeStamp = int(round(time.time() * 1000))
body = {
"timestamp": timeStamp,
"transfer_type": "withdraw", # "deposit" OR "withdraw" (to/from DF wallet)
"amount": 1,
"currency_short_name": "USDT"

}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()
url = "https://api.coindcx.com/exchange/v1/derivatives/futures/wallets/transfer"
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.post(url, data=json_body, headers=headers)
data = response.json()
print(json.dumps(data, indent=2))

Response

[
{
"id": "c5f039dd-4e11-4304-8f91-e9c1f62d754d",
"currency_short_name": "USDT",
"balance": "6.1693226",
"locked_balance": "0.0",
"cross_order_margin": "0.0",
"cross_user_margin": "0.68534648"
}
]

Wallet Details
Use this endpoint to fetch the wallet details for both INR & USDT Futures Wallet.

166/192
HTTP Request
GET https://api.coindcx.com/exchange/v1/derivatives/futures/wallets

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

Response Defnitions

KEY DESCRIPTION

id Futures wallet id

currency_short_name Currency of wallet

balance Ignore this

locked_balance Total initial margin locked in isolated margined orders and

positions

cross_order_margin Total initial margin locked in cross margined orders

cross_user_margin Total initial margin locked in cross margined positions

167/192
import hmac
import hashlib
import base64
import json
import time
import requests
# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"
# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)
# Generating a timestamp
timeStamp = int(round(time.time() * 1000))
body = {
"timestamp": timeStamp

}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()
url = "https://api.coindcx.com/exchange/v1/derivatives/futures/wallets"
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.get(url, data=json_body, headers=headers)
data = response.json()
print(json.dumps(data, indent=2))

Response

[
{
"id": "c5f039dd-4e11-4304-8f91-e9c1f62d754d",
"currency_short_name": "USDT",
"balance": "6.1693226",
"locked_balance": "0.0",
"cross_order_margin": "0.0",
"cross_user_margin": "0.68534648"
}
]

Wallet Transactions
Use this endpoint to fetch the list of wallet transactions for both INR & USDT Futures
Wallet.

HTTP Request

168/192
GET
https://api.coindcx.com/exchange/v1/derivatives/futures/wallets/transaction
s?page=1&size=1000

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

Response Defnitions

KEY DESCRIPTION

derivatives_futures_wallet_id Futures wallet id

transaction_type Credit (into futures wallet) or debit (from futures wallet)

amount Transaction amount

currency_short_name Currency of wallet

currency_full_name Currency full name of wallet

reason Reason will be

by_universal_wallet: For transfers between spot
and futures wallets.
by_futures_order: For all the transactions created
due to a futures order
by_futures_funding: For all the transaction created
due to funding (only applicable for fundings that
occur in cross margined positions)

created_at Timestamp at which the transaction got created

169/192
import hmac
import hashlib
import base64
import json
import time
import requests
# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"
# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)
# Generating a timestamp
timeStamp = int(round(time.time() * 1000))
body = {
"timestamp": timeStamp

}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()
url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/wallets/transactions?
page=1&size=1000"
headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}
response = requests.get(url, data=json_body, headers=headers)
data = response.json()
print(json.dumps(data, indent=2))

Response

[
{
"derivatives_futures_wallet_id": "c5f039dd-4e11-4304-8f91-e9c1f62d754d",
"transaction_type": "debit",
"amount": 1.0,
"currency_short_name": "USDT",
"currency_full_name": "Tether",
"reason": "by_universal_wallet",
"created_at": 1720547024000
}
]

Edit Order

170/192
Use this endpoint to edit the order which is in open status.
Note : Edit order is only supported on USDT margined Futures at the moment.

HTTP Request
POST https://api.coindcx.com/exchange/v1/derivatives/futures/orders/edit

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

id String YES Order id

total_quantity Integer YES New total quantity of the order

price Integer YES New price of the order

Response Defnitions

KEY DESCRIPTION

id Order id

pair Name of the futures pair

side Side buy / sell

status Ignore this (It will be initial for all the newly placed orders)

order_type Order type. Possible values are:

limit - a type of order where the execution price will be
no worse than the order's set price. The execution price
is limited to be the set price or better.
market - A type of order where the user buys or sells an
asset at the best available prices and liquidity until the
order is fully filled or the order book's liquidity is
exhausted.
stop_market - once the market price hits the stopPrice,
a market order is placed on the order book.
stop_limit - once the market price hits the stopPrice, a
limit order is placed on the order book at the limit price.
take_profit_market - once the market price hits the
stopPrice, a market order is placed on the order book.
take_profit_limit - once the market price hits the
stopPrice, a limit order is placed on the order book at
the limit price.

stop_trigger_instruction

171/192
notification no_notification OR email_notification. If property is set as
email_notification then you will get an email once the order is
filled

leverage This is the leverage at which you want to take a position. This
has to be the same as the leverage of the position. Else the
order will be rejected. You should preferably set the leverage
before placing the order to avoid order rejection. Leverage
needs to be set only once post which it will be saved in the
system for that particular pair.

maker_fee Applicable fee if the trade received for the order is a maker
trade

taker_fee Applicable fee if the trade received for the order is a taker
trade

liquidation_fee Applicable fee if the trade received for the order is a trade for
the liquidation order

fee_amount This will be the fee that has been charged for the user till
now. As soon as the order is placed, this value will be zero
until you start receiving trades for the order

price Order Price (limit price for limit, stop limit and take profit limit
orders). Keep this NULL for market orders. Else the order will
be rejected.

stop_price

avg_price It will be zero for the newly placed orders. You can check the
latest fill price from the list orders endpoint

total_quantity Total quantity of the order

remaining_quantity Remaining quantity of the order that is still open on the

exchange and can get filled

cancelled_quantity Quantity of the order that is canceled and won’t be filled

ideal_margin This is the margin that is required for placing this order. You
will see the ideal margin as non-zero even for reduce orders
but the actual margin locked for reduce orders will be 0. This
number is only for reference purpose.

locked_margin

order_category Ignore this

position_margin_type “crossed” if the order was placed for cross margin position.
“Isolated” if the order is placed for isolated margin position.
Please consider NULL also as isolated.

172/192
stage default - Standard limit, market, stop limit, stop market, take
profit limit or take profit market order
exit - Quick exit which closes the entire position
liquidate - Order which was created by the system to liquidate
a futures position
tpsl_exit - Take profit or stop loss order which was placed to
close the entire futures position

trades

group_id Group id is an id which is used whenever a large order is split

into smaller parts. System auto-splits the market variant
orders like quick exit order, liquidate order and tpsl_exit order
into smaller parts if the order size is huge. All the split parts
will have the same group id

metatags

display_message Ignore this

group_status Ignore this

created_at Timestamp at which the order was created

updated_at Last updated timestamp of the order

173/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp,
"id": "dd456ab4-4a7d-11ef-a287-bf3cd92be693",
"total_quantity": 12,
"price": 0.999501
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/exchange/v1/derivatives/futures/orders/edit"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(json.dumps(data, indent=2))

Response

174/192
[
{
"id": "dd456ab4-4a7d-11ef-a287-bf3cd92be693",
"pair": "B-USDC_USDT",
"side": "buy",
"status": "open",
"order_type": "limit_order",
"stop_trigger_instruction": "last_price",
"notification": "email_notification",
"leverage": 5.0,
"maker_fee": 0.025,
"taker_fee": 0.074,
"liquidation_fee": null,
"fee_amount": 0.0,
"price": 0.999501,
"stop_price": 0.0,
"avg_price": 0.0,
"total_quantity": 12.0,
"remaining_quantity": 12.0,
"cancelled_quantity": 0.0,
"ideal_margin": 2.402352627552,
"locked_margin": 2.402352627552,
"order_category": null,
"position_margin_type": "isolated",
"stage": "default",
"created_at": 1721908991520,
"updated_at": 1721909127960,
"trades": [],
"display_message": "Order edited successfully",
"group_status": null,
"group_id": null,
"metatags": null
}
]

Change Position Margin Type

Use this endpoint to change the margin type from "isolated" to "crossed" and vice-versa.
You can only update the margin type when you don't have any active position or open
orders in the instrument.

Note : Cross margin mode is only supported on USDT margined Futures at the moment.

HTTP Request
POST
https://api.coindcx.com/exchange/v1/derivatives/futures/positions/margin_ty
pe

Request Defnitions

175/192
Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

pair String YES Instrument Pair name, Format: B-BTC_USDT, B-

ETH_USDT, etc

margin_type Integer YES “Isolated” or “crossed”

Response Defnitions

KEY DESCRIPTION

id Position id

pair Name of the futures pair

active_pos Quantity of the position in terms of underlying. For example, if

active_pos = 1 for B-ETH_USDT then you hold 1 quantity ETH
Futures contract. For short positions, active_pos will be
negative.

inactive_pos_buy Sum of the open quantities of the pending buy orders.

inactive_pos_sell Sum of the open quantities of the pending sell orders.

avg_price Average entry price of the position.

liquidation_price Price at which the position will get liquidated. This is applicable
only for positions with isolated margin. Ignore this for cross
margined positions.

locked_margin Margin (in USDT) locked in the position after debiting fees and
adjusting funding from the initial investment.

locked_user_margin Margin (in USDT) that was initially invested in the futures
position excluding fees and funding.

locked_order_margin Total margin in USDT that is locked in the open orders.

take_profit_trigger Trigger price set for Full Position take profit order.

stop_loss_trigger Trigger price set for Full position stop loss order.

margin_type “crossed” if the order was placed for cross margin

position.“Isolated” if the order is placed for isolated margin
position.Please consider NULL also as isolated.

leverage Leverage of the position

176/192
maintenance_margin The amount of margin required to be maintained in the account
to avoid liquidation. For cross margined positions, the
maintenance margin required is equal to the sum of the
maintenance margins of all the positions

mark_price Mark price at the time when the position was last updated. Note
that this value is not real-time and is only for reference purpose.

updated_at Ignore this

177/192
import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "xxx"
secret = "yyy"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp,
"pair": "B-JTO_USDT",
"margin_type": "isolated", # "isolated" or "crossed"
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url =
"https://api.coindcx.com/exchange/v1/derivatives/futures/positions/margin_type"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.post(url, data=json_body, headers=headers)

data = response.json()
print(json.dumps(data, indent=2))

Response

178/192
[
{
"id": "6bcb26f8-4a7d-11ef-b553-6bef92793bf4",
"pair": "B-JTO_USDT",
"active_pos": 0.0,
"inactive_pos_buy": 0.0,
"inactive_pos_sell": 0.0,
"avg_price": 0.0,
"liquidation_price": 0.0,
"locked_margin": 0.0,
"locked_user_margin": 0.0,
"locked_order_margin": 0.0,
"take_profit_trigger": null,
"stop_loss_trigger": null,
"margin_type": "isolated",
"leverage": 5.0,
"mark_price": 0.0,
"maintenance_margin": 0.0,
"updated_at": 1721978237197
}
]

Get Currency Conversion

Use this endpoint to get the USDT currency conversion price in INR .

HTTP Request
POST https://api.coindcx.com/api/v1/derivatives/futures/data/conversions

Request Defnitions

Name Type Mandatory Description

timestamp Integer YES EPOCH timestamp in seconds

Response Defnitions

KEY DESCRIPTION

symbol Symbol Name

margin_currency_short_name INR

target_currency_short_name USDT

179/192
 conversion_price When using INR margin, CoinDCX notionally converts
INR to USDT & vice-versa at this conversion rate. This
conversion rate may change periodically due to
extreme market movements.

last_updated_at Timestamp at which the fixed conversion price was last

changed.

import hmac
import hashlib
import base64
import json
import time
import requests

# Enter your API Key and Secret here. If you don't have one, you can generate it
from the website.
key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
# secret_bytes = bytes(secret)

# Generating a timestamp
timeStamp = int(round(time.time() * 1000))

body = {
"timestamp": timeStamp,
}

json_body = json.dumps(body, separators=(',', ':'))

signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

url = "https://api.coindcx.com/api/v1/derivatives/futures/data/conversions"

headers = {
'Content-Type': 'application/json',
'X-AUTH-APIKEY': key,
'X-AUTH-SIGNATURE': signature
}

response = requests.get(url, data=json_body, headers=headers)

data = response.json()
print(json.dumps(data, indent=2))

Response

180/192
[
{
"symbol": "USDTINR",
"margin_currency_short_name": "INR",
"target_currency_short_name": "USDT",
"conversion_price": 89.0,
"last_updated_at": 1728460492399
}
]

Futures Sockets

Glossary
e - is the Event type
p - price (LTP)
q - quantity (trade quantity)
pr - product (futures)
f - futures
s - spot
T - timestamp
m - is maker. Boolean value that would be true if its maker and false if its taker
RT - range timestamp
ts - timestamp
vs - version
Ets - event timestamp as given by TPE (applicable to candlesticks data)
i - Interval
E - event timestamp (applicable to order book data)
pST - price sent time
v - volume 24h
ls - last price
pc - price change percent
btST - TPE Tick send time
mp - mark price
bmST - TPE mark price send time (The timestamp at which Third-Party exchange
sent this event)

ACCOUNT

181/192
import socketio
import hmac
import hashlib
import json
socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.Client()

sio.connect(socketEndpoint, transports = 'websocket')

key = "XXXX"
secret = "YYYY"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
# python2
secret_bytes = bytes(secret)

body = {"channel":"coindcx"}
json_body = json.dumps(body, separators = (',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

# Join channel
sio.emit('join', { 'channelName': 'coindcx', 'authSignature': signature, 'apiKey'
: key })

### Listen update on eventName

### Replace the <eventName> with the df-position-update, df-order-update,
###balance-update

@sio.on(<eventName>)
def on_message(response):
print(response["data"])

# leave a channel
sio.emit('leave', { 'channelName' : 'coindcx' })

Get Position Update

Definitions
Channel: coindcx
Event: df-position-update

@sio.on('df-position-update')
def on_message(response):
print(response["data"])

Response:

182/192
[
{
"id":"571eae12-236a-11ef-b36f-83670ba609ec",
"pair":"B-BNB_USDT",
"active_pos":0,
"inactive_pos_buy":0,
"inactive_pos_sell":0,
"avg_price":0,
"liquidation_price":0,
"locked_margin":0,
"locked_user_margin":0,
"locked_order_margin":0,
"take_profit_trigger":null,
"stop_loss_trigger":null,
"leverage":10,
"mark_price":0,
"maintenance_margin":0,
"updated_at":1717754279737,
"margin_type": "isolated",
"margin_currency_short_name" : "INR",
"settlement_currency_avg_price" : 89.0,

}
]

Get Order Update

Definitions

Channel: coindcx
Event: df-order-update

@sio.on('df-order-update')
def on_message(response):
print(response["data"])

Response:

183/192
[
{
"id":"ff5a645f-84b7-4d63-b513-9e2f960855fc",
"pair":"B-ID_USDT",
"side":"sell",
"status":"cancelled",
"order_type":"take_profit_limit",
"stop_trigger_instruction":"last_price",
"notification":"email_notification",
"leverage":1,
"maker_fee":0.025,
"taker_fee":0.075,
"fee_amount":0,
"price":0.9,
"stop_price":1,
"avg_price":0,
"total_quantity":0,
"remaining_quantity":0,
"cancelled_quantity":0,
"ideal_margin":0,
"order_category":"complete_tpsl",
"stage":"tpsl_exit",
"created_at":1705915012812,
"updated_at":1705999727686,
"trades":[

],
"display_message":null,
"group_status":null,
"group_id":null,
"metatags": null,
"margin_currency_short_name" : "INR",
"settlement_currency_conversion_price" : 89.0,

}
]

Get Balance Update

Definitions

Channel: coindcx
Event: balance-update

@sio.on('balance-update')
def on_message(response):
print(response["data"])

Response:

184/192
[
{
"id":"026ef0f2-b5d8-11ee-b182-570ad79469a2",
"balance":"1.0221449",
"locked_balance":"0.99478995",
"currency_id":"c19c38d1-3ebb-47ab-9207-62d043be7447",
"currency_short_name":"USDT"
}
]

Get Candlestick Data

Definitions
The set of candlestick resolutions available are ["1m", "5m", "15m", "30m", "1h", "4h",
"8h", "1d", "3d", "1w", "1M"]. For example for 15 minute candle please connect to channel
[instrument_name]_15m-futures

Channel: "[instrument_name]_1m-future" , "[instrument_name]_1h-futures", "

[instrument_name]_1d-futures" etc.Here [instrument_name] can be derived from
Get active instruments.
Example to join channel : ["join",{"channelName": "B-BTC_USDT_1m-futures" }]
Event: candlestick

@sio.on('candlestick')
def on_message(response):
print(response["data"])

Response:

185/192
{
"data":[
{
"open":"0.3524000",
"close":"0.3472000",
"high":"0.3531000",
"low":"0.3466000",
"volume":"5020395",
"open_time":1705514400,
"close_time":1705517999.999,
"pair":"B-ID_USDT",
"duration":"1h",
"symbol":"IDUSDT",
"quote_volume":"1753315.2309000"
}
],
"Ets":1705516366626,
"i":"1h",
"channel":"B-ID_USDT_1h-futures",
"pr":"futures"
}

Get Orderbook

Definitions

Channel: "[instrument_name]@orderbook@50-futures. Here [instrument_name]

can be derived from Get active instruments.Here 50 denotes, the depth of the order
book the other possible values are 10 and 20.
Example to join channel : ['join', {'channelName':"B-ID_USDT@orderbook@50-
futures"}]
Event: depth-snapshot

@sio.on('depth-snapshot')
def on_message(response):
print(response["data"])

Response:

186/192
{
"ts":1705913767265,
"vs":53727235,
"asks":{
"2410":"112.442",
"2409.77":"55.997",
"2409.78":"5.912"
},
"bids":{
"2409.76":"12.417",
"2409.75":"1.516",
"2409.74":"15.876"
},
"pr":"futures"
}

Get Current Prices

Definitions

Channel: currentPrices@futures@rt
Example to join channel : ['join', {'channelName':"currentPrices@futures@rt"}]
Event: currentPrices@futures#update

@sio.on('currentPrices@futures#update')
def on_message(response):
print(response["data"])

Response:

{
"vs":29358821,
"ts":1707384027242,
"pr":"futures",
"pST":1707384027230,
"prices":{
"B-UNI_USDT":{
"bmST":1707384027000,
"cmRT":1707384027149
},
"B-LDO_USDT":{
"mp":2.87559482,
"bmST":1707384027000,
"cmRT":1707384027149
}
}
}

Get New Trade

187/192
Definitions

Channel: "[instrument_name]@trades-futures. Here [instrument_name] can be

derived from Get active instruments
Example to join channel : ['join', {'channelName':"B-ID_USDT@trades-futures"}]
Event: new-trade

@sio.on('new-trade')
def on_message(response):
print(response["data"])

Response:

{
"T":1705516361108,
"RT":1705516416271.6133,
"p":"0.3473",
"q":"40",
"m":1,
"s":"B-ID_USDT",
"pr":"f"
}

Get LTP Data

Definitions

Channel: "[instrument_name]@trades-futures. Here [instrument_name] can be

derived from Get active instruments
Example to join channel : ['join', {'channelName':"B-ID_USDT@prices-futures"}]
Event: new-trade

@sio.on('price-change')
def on_message(response):
print(response["data"])

Response:

{
"T":1705516361108,
"p":"0.3473",
"pr":"f"
}

Sample code for Socket Connection

Definitions

188/192
Websocket connection implementation with ping check

189/192
import socketio
import hmac
import hashlib
import json
import time
import asyncio
from datetime import datetime
from socketio.exceptions import TimeoutError
socketEndpoint = 'wss://stream.coindcx.com'
sio = socketio.AsyncClient()

key = "xxx"
secret = "xxx"

# python3
secret_bytes = bytes(secret, encoding='utf-8')
channelName = "coindcx"
body = {"channel": channelName}
json_body = json.dumps(body, separators=(',', ':'))
signature = hmac.new(secret_bytes, json_body.encode(), hashlib.sha256).hexdigest()

async def ping_task():

while True:
await asyncio.sleep(25)
try:
await sio.emit('ping', {'data': 'Ping message'})
except Exception as e:
print(f"Error sending ping: {e}")

@sio.event
async def connect():
print("I'm connected!")
current_time = datetime.now()
print("Connected Time:", current_time.strftime("%Y-%m-%d %H:%M:%S"))

await sio.emit('join', {'channelName': "coindcx", 'authSignature': signature,

'apiKey': key})
await sio.emit('join', {'channelName': "B-ID_USDT@prices-futures"})

@sio.on('price-change')
async def on_message(response):
current_time = datetime.now()
print("Price Change Time:", current_time.strftime("%Y-%m-%d %H:%M:%S"))
print("Price Change Response !!!")
print(response)

async def main():

try:
await sio.connect(socketEndpoint, transports='websocket')
# Wait for the connection to be established
asyncio.create_task(ping_task())

190/192
 await sio.wait()
while True:
time.sleep(1)
sio.event('price-change', {'channelName': "B-ID_USDT@prices-futures"})
except Exception as e:
print(f"Error connecting to the server: {e}")
raise # re-raise the exception to see the full traceback

# Run the main function

if __name__ == '__main__':
asyncio.run(main())

Response:

FAQ
From where to start
Authentication
General API
Markets
Orders
Sockets
User Data
Handling Errors

Errors
The CoinDCX API uses the following error codes:

Error
Code Meaning

400 Bad Request -- Your request is invalid.

401 Unauthorized -- Your API key is wrong.

404 Not Found -- The specified link could not be found.

429 Too Many Requests -- You're making too many API calls

500 Internal Server Error -- We had a problem with our server. Try again later.

503 Service Unavailable -- We're temporarily offline for maintenance. Please try
again later.

High-Frequency Trading

191/192
CoinDCX’s API for High-Frequency Trading (HFT)

The base URL for all HFT API calls is `https://hft-api.coindcx.com`.

CoinDCX provides special access to our HFT APIs for enterprise and specialized clients.
These APIs will enable our clients to trade and receive market data with faster API
responses and higher API rate limits.

To receive this access, kindly contact our support team. Our team members will request
you for a static IP address which we will keep as our Trusted IPs for HFT. Once your IP
address has been added as ‘Trusted’, you will receive the required access to our HFT API
services.

192/192