RFQ

Request Quote (RFQ)

Request a quote for a currency conversion. Specify deliver quantity or receive quantity, but not both.

POSThttp://localhost:3001/api/v1/quotes

Body

application/json

one of

objectobject

Response

2004004014034XX5XX

Successful response

Body

application/json

quoteIdstring (uuid)

requestedAtDatetime

Date-time in ISO 8601 format

Example: "2024-08-01T18:44:05Z"

expiresAtDatetime

Date-time in ISO 8601 format

Example: "2024-08-01T18:44:05Z"

accountIdstring (uuid)

pairstring

Example: "BTC-USD"

sideenum

Example: "BUY"

BUYSELL

deliverQuantitystring (number)

Example: "103.06"

deliverCurrencystring

Example: "USD"

receiveQuantitystring (number)

Example: "0.0016"

receiveCurrencystring

Example: "BTC"

pricestring (number)

Example: "64237.47"

baseQuantitystring (number)

Example: "0.0016"

quoteQuantitystring (number)

Example: "10.74"

feeCurrencystring

Example: "USD"

clientFeeRatestring (integer)

The client fee rate in bps.

Example: "30"

clientFeeQuantitystring (float)

Example: "0.10"

providerFeeRatestring (integer)

The provider fee rate in bps.

Example: "30"

providerFeeQuantitystring (number)

Example: "0.08"

quoteStatusQuoteStatus (enum)

AWAITING_RESPONSECANCELEDEXPIREDACCEPTED

clientReferencenullable string

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/quotes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "pair": "BTC-USD",
      "side": "BUY",
      "deliverQuantity": "103.06",
      "clientFeeRate": "30"
    }),
});
const data = await response.json();

Response

200

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedAt": "2024-08-01T18:44:05Z",
  "expiresAt": "2024-08-01T18:44:05Z",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "pair": "BTC-USD",
  "side": "BUY",
  "deliverQuantity": "103.06",
  "deliverCurrency": "USD",
  "receiveQuantity": "0.0016",
  "receiveCurrency": "BTC",
  "price": "64237.47",
  "baseQuantity": "0.0016",
  "quoteQuantity": "10.74",
  "feeCurrency": "USD",
  "clientFeeRate": "30",
  "clientFeeQuantity": "0.10",
  "providerFeeRate": "30",
  "providerFeeQuantity": "0.08",
  "quoteStatus": "AWAITING_RESPONSE",
  "clientReference": "text"
}

Cancel Quote (RFQ)

Cancel a previously requested quote.

DELETEhttp://localhost:3001/api/v1/quotes/{quoteId}

Path parameters

quoteId*string (uuid)

The quoteId returned by the Request Quote

Response

2004004014034XX5XX

OK

Body

application/json

quoteIdstring (uuid)

quoteStatusstring

Example: "CANCELED"

canceledAtDatetime

Date-time in ISO 8601 format

Example: "2024-08-01T18:44:05Z"

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/quotes/{quoteId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "quoteStatus": "CANCELED",
  "canceledAt": "2024-08-01T18:44:05Z"
}

Execute a Quote (RFQ)

Execute a previously requested quote. Creates an Order and Executes it. Retuns both the order and the execution.

POSThttp://localhost:3001/api/v1/orders

Body

application/json

quoteId*string (uuid)

The quoteId returned by Request Quote

clientReferencestring

Response

2004004014034XX5XX

Successful response

Body

application/json

orderOrder

executionsarray of Execution

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3001/api/v1/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "quoteId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "order": {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "orderStatus": "PLACED",
    "side": "BUY",
    "pair": "BTC-USD",
    "strategy": "RFQ",
    "orderPrice": "52100.00",
    "orderQuantity": "1.00",
    "fillQuantity": "1.00",
    "fillPrice": "52100.00",
    "fillPercentage": "100",
    "clientFeeRate": "10",
    "providerFeeRate": "10",
    "placedAt": "2024-10-16T00:18:13.917Z",
    "completedAt": null,
    "clientReference": "text"
  },
  "executions": [
    {
      "executionId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "executedAt": "2024-10-16T00:18:13.917Z",
      "pair": "BTC-USD",
      "side": "BUY",
      "deliverCurrency": "BTC",
      "deliverQuantity": "1.00",
      "receiveCurrency": "USD",
      "receiveQuantity": "52100.00",
      "price": "52100.00",
      "baseQuantity": "0.0016",
      "quoteQuantity": "10.74",
      "clientFeeRate": "10",
      "providerFeeRate": "10",
      "clientFeeQuantity": "52.10",
      "providerFeeQuantity": "52.10",
      "feeCurrency": "USD",
      "executionStatus": "TRADE_EXECUTED",
      "tradeDate": "2024-10-16",
      "valueDate": "2024-10-16",
      "confirmedAt": "2024-10-16T00:18:13.917Z",
      "clientReference": "text"
    }
  ]
}