Query quote request (client ID)

Request

Query the state of quote request by the RFS ID clOrderId assigned by you when you sent the request. The response can include quotes, trades, and state of the Quote request.

Security

SSO_TOKEN

Query

clOrderIdstring, <= 255 charactersrequired

The ID assigned by you when you submitted the request. Sent in the clOrderId field of the request.

Example:clOrderId=view1MultiLP5

GET

/v2/rfs

JavaScript

const query = new URLSearchParams({
  clOrderId: 'view1MultiLP5'
}).toString();

const resp = await fetch(
  `https://docs.fxinside.net/_mock/openapi/integral-api-reference/rest/v2/rfs?${query}`,
  {
    method: 'GET',
    headers: {
      SSO_TOKEN: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);

Responses

A JSON object with the quote status. May include quotes and trades.

Bodyapplication/json

clOrderIdstring, <= 60 characters

ID assigned by you from your request. You need to use this ID or the server ID requestId to query your request to get quotes and status.

requestIdstring, <= 255 characters

Request ID assigned by Integral. Use this ID to accept a quote. You need to use this ID or your ID clOrderId to query your request to get quotes and status. Returned in requestId of Request quote.

transactionIdstring, <= 255 characters

Request transaction ID assigned by Integral. Must be included on quote acceptance in the RFQ workflow.

ttlnumber, (int32)

Originating RFS request expiry time.

eventstring, <= 50 characters

QUOTE: a quote in response to your request for quote.

Enum:"QUOTE""REQUEST_RECEIVED""REQUEST_EXPIRED""REQUEST_WITHDRAWN""REQUEST_DECLINED""REQUEST_ACCEPTED""TRADE_VERIFIED""TRADE_PENDING""TRADE_REJECTED"

Discriminator

quotesArray of objects(quote)

Collection of quotes.

Response

{
  "clOrderId": "rjv_566",
  "requestId": "G4796976d5_228bd_19587256c877",
  "transactionId": "FXI9445344076",
  "ttl": 7200,
  "event": "QUOTE",
  "quotes": [
    { … }
  ]
}