API Reference

Subscribe to Order Channel

Once prices are streaming, a quote can be executed using the order message

📘

To call this endpoint, the API Key need to have the Place and Manage Orders permission enabled (via Zodia Markets website).

Execute Order

Request

OrderRequest

To accept a quote published by Zodia Markets (submit an order against quote ID from price channel).

FieldReq’dTypeDescription
messageTypeYStringorder
quoteIdYStringQuote ID of quote being executed
sideYStringBUY if executing against an offer
SELL if executing against a bid
clientRequestIdYStringClient supplied order identifier
accountGrpUuidNStringAccount group ref to use. Use default account if not supplied
quantityNStringShould be <= the Subscribe Quantity. If not specified, will use the subscribe quantity

Request example:

{
    "messageType": "order",
    "quoteId": "YdB4DodjOC5FkBDrYmKLW/Dwnz+x9bVbXyshrwz8yntjA+kZAbSAfeCiHba7GBorgzh61EJP2FOf+81m",
    "side": "BUY",
    "clientRequestId": "TESTCLIENT1",
    "accountGrpUuid": "7687282f-1073-441b-9ff4-694e6b49effe"
}

Response

Where an order has been successfully executed, client will receive the following confirmation.

FieldReq'dTypeDescription
messageTypeYStringorder or error
timestampYLongtime of execution in milliseconds
messageYStringConfirmation message
codeYStringError code
instrumentYStringCurrency-pair but with "." as a separator of base currency and quote currency.
sideYStringBUY if executing against an offer
SELL if executing against a bid
priceYStringPrice at which the order was filled
quantityYStringQuantity equal to the quoted quantity
clientRequestIdYStringClient supplied order identifier
orderStatusYStringOrder Status SUCCESS or FAILED
quoteIdYStringQuote ID of quote being executed
transactionIdYStringSystem generated reference Id
settleDateYStringThe Value Date the quote is executed against. This is the date settlement is expected by.
TenorYStringThe Tenor on the subscription

Response example:

{
    "timestamp": 409937058888162,
    "messageType": "order",
    "message": "",
    "code": "",
    "instrument": "USDC.AED",
    "side": "BUY",
    "price": "38790.007200",
    "quantity": "100000",
    "clientRequestId": "TESTCLIENT1",
    "orderStatus": "SUCCESS",
    "quoteId": "YdB4DodjOC5FkBDrYmKLW/Dwnz+x9bVbXyshrwz8yntjA+kZAbSAfeCiHba7GBorgzh61EJP2FOf+81m",
    "transactionId": "774722250a694498b916b7bac07bb48e",
    "tenor": "T",
    "settleDate": "20240811"
}

{
    "timestamp": 1718113605032,
    "messageType": "error",
    "message": "Please contact your desk support.",
    "clientRequestId": "TESTCLIENT1",
    "code": "RFS500001",
    "quoteId": "YdB4DodjOC5FkBDrYmKLW/Dwnz+x9bVbXyshrwz8yntjA+kZAbSAfeCiHba7GBorgzh61EJP2FOf+81m",
    "transactionId": ""
}