API Reference
Start typing to search…

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).

Field

Req’d

Type

Description

messageType

Y

String

order

quoteId

Y

String

Quote ID of quote being executed

side

Y

String

BUY if executing against an offer
SELL if executing against a bid

clientRequestId

Y

String

Client supplied order identifier

accountGrpUuid

N

String

Account group ref to use. Use default account if not supplied

quantity

N

String

Should be <= the Subscribe Quantity. If not specified, will use the subscribe quantity. Specified in currency provided on price SubscribeRequest

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.

Field

Req'd

Type

Description

messageType

Y

String

order or error

timestamp

Y

Long

time of execution in milliseconds

message

Y

String

Confirmation message

code

Y

String

Error code

instrument

Y

String

Currency-pair but with "." as a separator of base currency and quote currency.

side

Y

String

BUY if executing against an offer
SELL if executing against a bid

price

Y

String

Price at which the order was filled

quantity

Y

String

Quantity equal to the quoted quantity

clientRequestId

Y

String

Client supplied order identifier

orderStatus

Y

String

Order Status SUCCESS or FAILED

quoteId

Y

String

Quote ID of quote being executed

transactionId

Y

String

System generated reference Id

settleDate

Y

String

The Value Date the quote is executed against. This is the date settlement is expected by.

Tenor

Y

String

The 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": ""
}