Algo724 Cadenza Lite API (1.15.0)

Download OpenAPI specification:Download

License: MIT

OpenAPI Specification for Algo724 Cadenza Lite API

Utility

Health check

Authorizations:

BearerAuth

Responses

Account

Exchange Account management

Get user information

Check available exchange types in user information

Authorizations:

BearerAuth

Responses

Response samples

200
400
500

Content type

application/json

{"exchangeTypes": ["BINANCE",
"B2C2",
"WINTERMUTE"
]
}

Add exchange account

Authorizations:

BearerAuth

Request Body schema: application/json

exchangeType required	string (exchangeType) Enum: "BINANCE" "BINANCE_MARGIN" "B2C2" "WINTERMUTE" "BLOCKFILLS" "STONEX" "CUMBERLAND" Exchange type
apiKey required	string API key
apiSecret required	string API secret
exchangeAccountName required	string Exchange account name, Available characters: a-z, A-Z, 0-9, _, (space)
environment required	integer Enum: 0 1 Environment(0 - real, 1 - sandbox)

Responses

Request samples

Payload

Content type

application/json

{"exchangeType": "BINANCE",
"apiKey": "my_api_key",
"apiSecret": "my_api_secret",
"exchangeAccountName": "my_exchange",
"environment": 0
}

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

List exchange accounts

Authorizations:

BearerAuth

Responses

Response samples

200
400
500

Content type

application/json

[{"accountType": "SPOT",
"exchangeType": "BINANCE",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"name": "string",
"environment": "REAL",
"status": "ACTIVE"
}
]

Update exchange account

Update exchange account, now only support Binance account API key and secret

Authorizations:

BearerAuth

Request Body schema: application/json

exchangeAccountId required	string <uuid> Exchange account ID
exchangeAccountName	string Exchange account name, Available characters: a-z, A-Z, 0-9, _, (space)
apiKey	string API key
apiSecret	string API secret

Responses

Request samples

Payload

Content type

application/json

{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountName": "my_exchange",
"apiKey": "my_api_key",
"apiSecret": "my_api_secret"
}

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Remove exchange account

Remove exchange account, now only support Binance account API key and secret

Authorizations:

BearerAuth

Request Body schema: application/json

exchangeAccountId

required

string <uuid>

Exchange account ID

Responses

Request samples

Payload

Content type

application/json

{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96"
}

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Set the priority of exchanges

Authorizations:

BearerAuth

Request Body schema: application/json

priority

required

Array of strings

Priority list of exchanges in descending order

Responses

Request samples

Payload

Content type

application/json

{"priority": ["my_exchange_1",
"my_exchange_2",
"my_exchange_3"
]
}

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Market

Market data

List available exchange symbols

Authorizations:

BearerAuth

query Parameters

exchangeType	string (exchangeType) Enum: "BINANCE" "BINANCE_MARGIN" "B2C2" "WINTERMUTE" "BLOCKFILLS" "STONEX" "CUMBERLAND" Exchange type
symbol	string Symbol
detail	boolean Example: detail=false Whether to return detailed information

Responses

Response samples

200
400
500

Content type

application/json

[{"baseSymbol": "BTC",
"description": "string",
"exchangeType": "BINANCE",
"marginRate": 0,
"maxQuantity": 0,
"minQuantity": 0,
"quantityStep": 0,
"minTick": 0,
"orderTypes": ["MARKET"
],
"pipSize": 0,
"pipValue": 0,
"pricePrecision": 0,
"quantityPrecision": 0,
"quoteSymbol": "USDT",
"securityType": "SPOT",
"symbol": "BTC/USDT",
"timeInForce": ["DAY"
]
}
]

Symbol price

Authorizations:

BearerAuth

query Parameters

exchangeType	string (exchangeType) Enum: "BINANCE" "BINANCE_MARGIN" "B2C2" "WINTERMUTE" "BLOCKFILLS" "STONEX" "CUMBERLAND" Exchange type
symbol required	string Example: symbol=BTC/USDT Symbol

Responses

Response samples

200
400
500

Content type

application/json

[{"askPrice": 0,
"askQuantity": 0,
"bidPrice": 0,
"bidQuantity": 0,
"exchangeType": "BINANCE",
"lastPrice": 0,
"lastQuantity": 0,
"symbol": "BTC/USDT",
"timestamp": 1632933600000
}
]

Order book

Get order book

Authorizations:

BearerAuth

query Parameters

exchangeType required	string (exchangeType) Enum: "BINANCE" "BINANCE_MARGIN" "B2C2" "WINTERMUTE" "BLOCKFILLS" "STONEX" "CUMBERLAND" Exchange type
symbol required	string Example: symbol=BTC/USDT Symbol
limit	integer Example: limit=100 Limit the number of returned results.

Responses

Response samples

200
400
500

Content type

application/json

[{"asks": [[0,
0
]
],
"bids": [[0,
0
]
],
"exchangeType": "string",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"symbol": "string",
"level": 0
}
]

Historical kline data

Get historical kline data

Authorizations:

BearerAuth

query Parameters

exchangeType required	string (exchangeType) Enum: "BINANCE" "BINANCE_MARGIN" "B2C2" "WINTERMUTE" "BLOCKFILLS" "STONEX" "CUMBERLAND" Exchange type
symbol required	string Example: symbol=BTC/USDT Symbol
interval required	string (interval) Enum: "1s" "1m" "5m" "15m" "30m" "1h" "2h" "1d" "1w" Kline interval
startTime	integer (millisecond) Example: startTime=1632933600000 Start time (in unix milliseconds)
endTime	integer (millisecond) Example: endTime=1632933600000 End time (in unix milliseconds)
limit	integer Example: limit=100 Limit the number of returned results.

Responses

Response samples

200
400
500

Content type

application/json

{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"symbol": "string",
"interval": "1s",
"candles": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
]
}

Trading

Place order

Authorizations:

BearerAuth

header Parameters

Idempotency-Key

string

Example: my_idempotency_key

Idempotency key is used to ensure that the same request is not processed more than once. If the same request is received again, the server will return the same response as the first time.

Request Body schema: application/json

quoteRequestId	string <uuid> (uuidString) UUID string
exchangeAccountId	string <uuid> (uuidString) UUID string
leverage	integer Levarage
orderSide	string Enum: "BUY" "SELL" Order side
orderType	string Enum: "MARKET" "LIMIT" "STOP_LOSS" "STOP_LOSS_LIMIT" "TAKE_PROFIT" "TAKE_PROFIT_LIMIT" "QUOTED" Order type
positionId	string <uuid> Position ID for closing position in margin trading
price	number Price
priceSlippageTolerance	number Price slippage tolerance, range: [0, 0.1] with 2 decimal places
quantity	number Quantity. One of quantity or quoteQuantity must be provided. If both is provided, only quantity will be used.
quoteQuantity	number Quote Quantity
symbol	string Symbol
timeInForce	string Enum: "DAY" "GTC" "GTX" "GTD" "OPG" "CLS" "IOC" "FOK" "GFA" "GFS" "GTM" "MOO" "MOC" "EXT" Time in force
routePolicy required	string (routePolicy) Enum: "PRIORITY" "QUOTE" Route policy. For PRIORITY, the order request will be routed to the exchange account with the highest priority. For QUOTE, the system will execute the execution plan based on the quote. Order request with route policy QUOTE will only accept two parameters, quoteRequestId and priceSlippageTolerance
priority	Array of strings Priority list of exchange account ID in descending order
quoteId	string Quote ID used by exchange for RFQ, e.g. WINTERMUTE need this field to execute QUOTED order
tenantId	string Tenant ID

Responses

Request samples

Payload

Content type

application/json

{"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"leverage": 0,
"orderSide": "BUY",
"orderType": "MARKET",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"price": 0,
"priceSlippageTolerance": 0,
"quantity": 0,
"quoteQuantity": 0,
"symbol": "BTC/USDT",
"timeInForce": "DAY",
"routePolicy": "PRIORITY",
"priority": ["exchange_account_id_1",
"exchange_account_id_2",
"exchange_account_id_3"
],
"quoteId": "string",
"tenantId": "tenantId"
}

Response samples

200
400
500

Content type

application/json

[{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
]

Cancel order

Cancel order. If the order is already filled, it will return an error.

Authorizations:

BearerAuth

Request Body schema: application/json

orderId

required

string

Order ID

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string"
}

Response samples

200
400
500

Content type

application/json

{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}

List Exchange Orders

List orders

Authorizations:

BearerAuth

query Parameters

orderId	string Order ID
orderStatus	string (orderStatus) Enum: "SUBMITTED" "ACCEPTED" "OPEN" "PARTIALLY_FILLED" "FILLED" "CANCELED" "PENDING_CANCEL" "REJECTED" "EXPIRED" "REVOKED" Order status
exchangeAccountId	string Exchange account ID
symbol	string Symbol
startTime	integer (millisecond) Example: startTime=1632933600000 Start time (in unix milliseconds)
endTime	integer (millisecond) Example: endTime=1632933600000 End time (in unix milliseconds)
limit	integer Example: limit=100 Limit the number of returned results.
offset	integer Example: offset=0 Offset of the returned results. Default: 0
tenantId	string Tenant ID
ascending	boolean Return records in ascending order

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
],
"limit": 0,
"offset": 0,
"total": 0
}

Get Quote Execution Report

Quote will give the best quote from all available exchange accounts

Authorizations:

BearerAuth

query Parameters

quoteRequestId

string

Quote Request ID

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"routePolicy": "PRIORITY",
"order": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
},
"filled": 1,
"cost": 42859.99,
"fees": [{"asset": "string",
"quantity": 0
}
],
"status": "SUBMITTED",
"createdAt": 1632933600000,
"updatedAt": 1632933600000,
"executions": [{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
]
}
],
"limit": 0,
"offset": 0,
"total": 0
}

List Execution Reports

Quote will give the best quote from all available exchange accounts

Authorizations:

BearerAuth

query Parameters

quoteRequestId	string Quote Request ID
startTime	integer (millisecond) Example: startTime=1632933600000 Start time (in unix milliseconds)
endTime	integer (millisecond) Example: endTime=1632933600000 End time (in unix milliseconds)
limit	integer Example: limit=100 Limit the number of returned results.
offset	integer Example: offset=0 Offset of the returned results. Default: 0
ascending	boolean Return records in ascending order

Responses

Response samples

200
400
500

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"routePolicy": "PRIORITY",
"order": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
},
"filled": 1,
"cost": 42859.99,
"fees": [{"asset": "string",
"quantity": 0
}
],
"status": "SUBMITTED",
"createdAt": 1632933600000,
"updatedAt": 1632933600000,
"executions": [{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
]
}
],
"limit": 0,
"offset": 0,
"total": 0
}

RFQ, Request for Quote, Indicated Quote, National Best Bid Offer, NBBO

Quote will give the best quote from all available exchange accounts

Authorizations:

BearerAuth

Request Body schema: application/json
required

baseCurrency required	string Base currency is the currency you want to buy or sell
quoteCurrency required	string Quote currency is the currency you want to pay or receive, and the price of the base currency is quoted in the quote currency
orderSide required	string Order side, BUY or SELL
quantity	number Amount of the base currency
quoteQuantity	number Amount of the quote currency
exchangeAccountId	string <uuid> (uuidString) UUID string
exchangeAccountIds	Array of strings <uuid> (uuidString) [ items <uuid > ]
crossCurrency	string The intermediary currency used for cross-currency quotes
disableCrossAccounts	boolean When true, prevents quotes from being sourced across multiple accounts
clientOrderId	string (clientOrderId) [ 1 .. 64 ] characters ^[a-zA-Z0-9_-]{1,64}$ Client-provided order identifier that must be unique

Responses

Request samples

Payload

Content type

application/json

{"baseCurrency": "string",
"quoteCurrency": "string",
"orderSide": "string",
"quantity": 0,
"quoteQuantity": 0,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"crossCurrency": "USD",
"disableCrossAccounts": false,
"clientOrderId": "my_order_123"
}

Response samples

200
400
500

Content type

application/json

[{"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"quantity": 1,
"quoteQuantity": 42859.99,
"quotePrice": 42859.99,
"orderSide": "BUY",
"clientOrderId": "my_order_123",
"askPrice": 42859.99,
"askQuantity": 1,
"bidPrice": 42859.71,
"bidQuantity": 1,
"timestamp": 1632933600000,
"createdAt": 1632933600000,
"validUntil": 1632933600000,
"expireAt": 1632933600000,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE"
}
]

IB

IB Operation

Create Account

Authorizations:

BearerAuth

Request Body schema: application/json
required

username required	string (Username)
consumer_key	string or null (Consumer Key)
dhparam	string or null (Dhparam)
encryption_private_key	string or null (Encryption Private Key)
signature_private_key	string or null (Signature Private Key)
access_token	string or null (Access Token)
access_token_secret	string or null (Access Token Secret)
live_session_token	string or null (Live Session Token)

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"consumer_key": "string",
"dhparam": "string",
"encryption_private_key": "string",
"signature_private_key": "string",
"access_token": "string",
"access_token_secret": "string",
"live_session_token": "string"
}

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"account_id": "string",
"master_id": "785bf4bf-4b84-45a0-bc70-ed22c473646e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_auth_method": "string",
"session_status": "string",
"conn_status": "string"
}

List Accounts

Authorizations:

BearerAuth

Responses

Response samples

200
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"account_id": "string",
"master_id": "785bf4bf-4b84-45a0-bc70-ed22c473646e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_auth_method": "string",
"session_status": "string",
"conn_status": "string"
}
]

Get Account

Authorizations:

BearerAuth

path Parameters

account_username

required

string (Account Username)

Responses

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"account_id": "string",
"master_id": "785bf4bf-4b84-45a0-bc70-ed22c473646e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_auth_method": "string",
"session_status": "string",
"conn_status": "string"
}

Connect

Authorizations:

BearerAuth

path Parameters

account_username

required

string (Account Username)

Responses

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"account_id": "string",
"master_id": "785bf4bf-4b84-45a0-bc70-ed22c473646e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_auth_method": "string",
"session_status": "string",
"conn_status": "string"
}

Disconnect

Authorizations:

BearerAuth

path Parameters

account_username

required

string (Account Username)

Responses

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string",
"account_id": "string",
"master_id": "785bf4bf-4b84-45a0-bc70-ed22c473646e",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_auth_method": "string",
"session_status": "string",
"conn_status": "string"
}

Portfolio

List Portfolio Summary

Authorizations:

BearerAuth

query Parameters

exchangeAccountId	string Exchange account ID
hideEmptyValue	boolean Hide small account

Responses

Response samples

200
400
500

Content type

application/json

[{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"balances": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
],
"positions": [{"amount": 0,
"cost": 0,
"entryPrice": 0,
"positionSide": "LONG",
"status": "OPEN",
"symbol": "BTC/USDT"
}
],
"credit": {"exchangeAccountId": "018e41a1-cebc-7b49-a729-ae2c1c41e297",
"exchangeType": "BINANCE",
"accountType": "SPOT",
"currency": "USDT",
"leverage": 1,
"credit": 10000,
"margin": 5000,
"marginLoan": 3000,
"marginRequirement": 1500,
"marginUsage": 0.5,
"marginLevel": 0.89,
"riskExposure": 5677517.76,
"maxRiskExposure": 5000000,
"riskExposureRate": 0.89
},
"updatedAt": 1632933600000
}
]

List credit

Authorizations:

BearerAuth

query Parameters

exchangeAccountId	string Exchange account ID
hideEmptyValue	boolean Hide small account

Responses

Response samples

200
400
500

Content type

application/json

[{"exchangeAccountId": "018e41a1-cebc-7b49-a729-ae2c1c41e297",
"exchangeType": "BINANCE",
"accountType": "SPOT",
"currency": "USDT",
"leverage": 1,
"credit": 10000,
"margin": 5000,
"marginLoan": 3000,
"marginRequirement": 1500,
"marginUsage": 0.5,
"marginLevel": 0.89,
"riskExposure": 5677517.76,
"maxRiskExposure": 5000000,
"riskExposureRate": 0.89
}
]

List balances

Authorizations:

BearerAuth

query Parameters

exchangeAccountId	string Exchange account ID
hideEmptyValue	boolean Hide small account

Responses

Response samples

200
400
500

Content type

application/json

[{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"balances": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
]
}
]

List positions

Authorizations:

BearerAuth

query Parameters

exchangeAccountId	string Exchange account ID
hideEmptyValue	boolean Hide small account

Responses

Response samples

200
400
500

Content type

application/json

[{"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"positions": [{"amount": 0,
"cost": 0,
"entryPrice": 0,
"positionSide": "LONG",
"status": "OPEN",
"symbol": "BTC/USDT"
}
]
}
]

Webhook

PubSub event handler

PubSub Event Handler

Authorizations:

BearerAuth

Request Body schema: application/json
required

required	object
subscription required	string The subscription name.

Responses

Request samples

Payload

Content type

application/json

{"message": {"data": "string",
"id": "string"
},
"subscription": "string"
}

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Cloud scheduler updatePortfolioRoutine webhook handler

Cloud scheduler update portfolio routine task

Authorizations:

BearerAuth

Responses

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Cloud scheduler updateOrdersRoutine webhook handler

Cloud scheduler update Orders Routine task

Authorizations:

BearerAuth

Responses

Response samples

200
400
500

Content type

application/json

{"data": "ok"
}

Event

PubSub event handler placeholder

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
payload	object The actual data of the event, which varies based on the event type.

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": { }
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": { }
}

PubSub event handler placeholder for quote request acknowledgment event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (quoteRequest)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"baseCurrency": "string",
"quoteCurrency": "string",
"orderSide": "string",
"quantity": 0,
"quoteQuantity": 0,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"crossCurrency": "USD",
"disableCrossAccounts": false,
"clientOrderId": "my_order_123"
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"baseCurrency": "string",
"quoteCurrency": "string",
"orderSide": "string",
"quantity": 0,
"quoteQuantity": 0,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"crossCurrency": "USD",
"disableCrossAccounts": false,
"clientOrderId": "my_order_123"
}
}

PubSub event handler placeholder for quote request acknowledgment event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (quoteRequest)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"baseCurrency": "string",
"quoteCurrency": "string",
"orderSide": "string",
"quantity": 0,
"quoteQuantity": 0,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"crossCurrency": "USD",
"disableCrossAccounts": false,
"clientOrderId": "my_order_123"
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"baseCurrency": "string",
"quoteCurrency": "string",
"orderSide": "string",
"quantity": 0,
"quoteQuantity": 0,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeAccountIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"crossCurrency": "USD",
"disableCrossAccounts": false,
"clientOrderId": "my_order_123"
}
}

PubSub event handler placeholder for place order request acknowledgment event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (placeOrderRequest)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"leverage": 0,
"orderSide": "BUY",
"orderType": "MARKET",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"price": 0,
"priceSlippageTolerance": 0,
"quantity": 0,
"quoteQuantity": 0,
"symbol": "BTC/USDT",
"timeInForce": "DAY",
"routePolicy": "PRIORITY",
"priority": ["exchange_account_id_1",
"exchange_account_id_2",
"exchange_account_id_3"
],
"quoteId": "string",
"tenantId": "tenantId"
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"leverage": 0,
"orderSide": "BUY",
"orderType": "MARKET",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"price": 0,
"priceSlippageTolerance": 0,
"quantity": 0,
"quoteQuantity": 0,
"symbol": "BTC/USDT",
"timeInForce": "DAY",
"routePolicy": "PRIORITY",
"priority": ["exchange_account_id_1",
"exchange_account_id_2",
"exchange_account_id_3"
],
"quoteId": "string",
"tenantId": "tenantId"
}
}

PubSub event handler placeholder for cancel order request acknowledgment event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (cancelOrderRequest)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"orderId": "string"
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"orderId": "string"
}
}

PubSub event handler placeholder for quote event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (quote)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"quantity": 1,
"quoteQuantity": 42859.99,
"quotePrice": 42859.99,
"orderSide": "BUY",
"clientOrderId": "my_order_123",
"askPrice": 42859.99,
"askQuantity": 1,
"bidPrice": 42859.71,
"bidQuantity": 1,
"timestamp": 1632933600000,
"createdAt": 1632933600000,
"validUntil": 1632933600000,
"expireAt": 1632933600000,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE"
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"quoteRequestId": "934d900e-84a8-48c9-b041-cbff0d908da7",
"quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"quantity": 1,
"quoteQuantity": 42859.99,
"quotePrice": 42859.99,
"orderSide": "BUY",
"clientOrderId": "my_order_123",
"askPrice": 42859.99,
"askQuantity": 1,
"bidPrice": 42859.71,
"bidQuantity": 1,
"timestamp": 1632933600000,
"createdAt": 1632933600000,
"validUntil": 1632933600000,
"expireAt": 1632933600000,
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE"
}
}

PubSub event handler placeholder for order event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (order)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
}

PubSub event handler for execution report drop copy event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (executionReport)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"routePolicy": "PRIORITY",
"order": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
},
"filled": 1,
"cost": 42859.99,
"fees": [{"asset": "string",
"quantity": 0
}
],
"status": "SUBMITTED",
"createdAt": 1632933600000,
"updatedAt": 1632933600000,
"executions": [{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
]
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"routePolicy": "PRIORITY",
"order": {"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
},
"filled": 1,
"cost": 42859.99,
"fees": [{"asset": "string",
"quantity": 0
}
],
"status": "SUBMITTED",
"createdAt": 1632933600000,
"updatedAt": 1632933600000,
"executions": [{"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"tenantId": "tenantId",
"positionId": "da3402dc-13f8-45f9-83a6-bde06dd8eb35",
"quoteId": "string",
"symbol": "BTC/USDT",
"baseCurrency": "BTC",
"quoteCurrency": "USDT",
"orderSide": "BUY",
"orderType": "MARKET",
"timeInForce": "DAY",
"status": "SUBMITTED",
"quantity": 0,
"quoteQuantity": 0,
"price": 0,
"limitPrice": 0,
"stopPrice": 0,
"executedPrice": 0,
"cost": 0,
"filled": 0,
"fee": 0,
"feeCurrency": "USDT",
"createdAt": 1703052635110,
"updatedAt": 1703052635111
}
]
}
}

PubSub event handler placeholder for portfolio event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (exchangeAccountPortfolio)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"balances": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
],
"positions": [{"amount": 0,
"cost": 0,
"entryPrice": 0,
"positionSide": "LONG",
"status": "OPEN",
"symbol": "BTC/USDT"
}
],
"credit": {"exchangeAccountId": "018e41a1-cebc-7b49-a729-ae2c1c41e297",
"exchangeType": "BINANCE",
"accountType": "SPOT",
"currency": "USDT",
"leverage": 1,
"credit": 10000,
"margin": 5000,
"marginLoan": 3000,
"marginRequirement": 1500,
"marginUsage": 0.5,
"marginLevel": 0.89,
"riskExposure": 5677517.76,
"maxRiskExposure": 5000000,
"riskExposureRate": 0.89
},
"updatedAt": 1632933600000
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"balances": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
],
"positions": [{"amount": 0,
"cost": 0,
"entryPrice": 0,
"positionSide": "LONG",
"status": "OPEN",
"symbol": "BTC/USDT"
}
],
"credit": {"exchangeAccountId": "018e41a1-cebc-7b49-a729-ae2c1c41e297",
"exchangeType": "BINANCE",
"accountType": "SPOT",
"currency": "USDT",
"leverage": 1,
"credit": 10000,
"margin": 5000,
"marginLoan": 3000,
"marginRequirement": 1500,
"marginUsage": 0.5,
"marginLevel": 0.89,
"riskExposure": 5677517.76,
"maxRiskExposure": 5000000,
"riskExposureRate": 0.89
},
"updatedAt": 1632933600000
}
}

PubSub event handler placeholder for order book event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (orderbook)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"asks": [[0,
0
]
],
"bids": [[0,
0
]
],
"exchangeType": "string",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"symbol": "string",
"level": 0
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"asks": [[0,
0
]
],
"bids": [[0,
0
]
],
"exchangeType": "string",
"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"symbol": "string",
"level": 0
}
}

PubSub event handler placeholder for kline event

Authorizations:

BearerAuth

Request Body schema: application/json
required

eventId required	string A unique identifier for the event.
eventType required	string (EventType) Enum: "cadenza.task.quote" "cadenza.dropCopy.quoteRequestAck" "cadenza.dropCopy.placeOrderRequestAck" "cadenza.dropCopy.cancelOrderRequestAck" "cadenza.dropCopy.quote" "cadenza.dropCopy.order" "cadenza.dropCopy.executionReport" "cadenza.dropCopy.portfolio" "cadenza.marketData.orderBook" "cadenza.marketData.kline" Event Type
source	string The source system or module that generated the event.
timestamp required	integer (millisecond) Unix timestamp in milliseconds
	object (kline)

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"symbol": "string",
"interval": "1s",
"candles": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
]
}
}

Response samples

200
400
500

Content type

application/json

{"eventId": "string",
"eventType": "cadenza.task.quote",
"source": "string",
"timestamp": 1632933600000,
"payload": {"exchangeAccountId": "0378501b-c811-45d5-8f0a-408d80cb2c96",
"exchangeType": "BINANCE",
"symbol": "string",
"interval": "1s",
"candles": [{"asset": "BTC",
"free": 1,
"locked": 0,
"borrowed": 3,
"net": -2,
"total": 1
}
]
}
}