Trade ESP spot

Goal

Execute a spot trade with ESP rates, from login and requesting rates to downloading the done trade.

Prerequisites

Your REST API app.
Integral API login with trading permission.
Your organization provisioned with at least one provider who streams ESP spot prices.

Steps

Use the Login and get token endpoint.

See the related Login tutorial.

Your access token is in SSO_TOKEN of the response header. Your token is valid for limited time.

Pass the SSO_TOKEN cookie value with all of your subsequent API requests.

application/json

{
  "user": "apiUserId",
  "pass": "This is a long password!",
  "org": "apiOrganizationId"
}

Response

application/json

{
  "status": "OK",
  "errorCode": null,
  "responseTuples": null,
  "expiryTime": 1665490480729,
  "serverUTCTime": 1665490420730
}

Step 2: Get spot prices

Use the Get spot rate by symbol endpoint.

See the related Get spot prices tutorial.

No request payload

Response

application/json

{
  "symbol": "EUR/USD",
  "bid": 1.1863,
  "offer": 1.18638,
  "bidLimit": 1000000,
  "offerLimit": 1000000,
  "time": 1602536120080,
  "rateId": "2022-11-10-EURUSD-SPOT-435ef73249"
}

Step 3: Place order

Use the Place order endpoint.

See the related Place an order (limit) tutorial.

To get your order status, you must query your order. After the initial success/fail response, status updates are not pushed to you.

Response

application/json

Successful limit order

{
  "coId": "8932452311944",
  "type": "Limit",
  "timeInForce": "IOC",
  "side": "Buy",
  "currency": "EUR",
  "symbol": "EUR/USD",
  "size": 1000000,
  "org": "BrokerOrg1",
  "price": 1.0971678,
  "orderId": "4820276016",
  "userFullName": "User1@pfOrg",
  "action": "place",
  "status": "RECEIVED"
}

Step 4: Query order

To get your order status, you must query your order. After the initial success/fail response, status updates are not pushed to you.

Use the Query order (server ID) endpoint.

The diagram shows the values returned in the status field in the response.

Order status transition (PQ order, success)

Order status transition (failure)

No request payload

Response

application/json

Successful limit order

{
  "coId": "8932452311944",
  "type": "Limit",
  "timeInForce": "IOC",
  "side": "Buy",
  "currency": "EUR",
  "symbol": "EUR/USD",
  "size": 1000000,
  "org": "BrokerOrg1",
  "price": 1.0971678,
  "orderId": "4820276016",
  "userFullName": "User1@pfOrg",
  "action": "place",
  "status": "RECEIVED"
}

Step 5: Download trade

Use the Get trades endpoint.

The endpoint returns all executed trades that have not been downloaded before.

Use the orderId from the 202 response when you placed the order to get your trade from the array of returned trades.

No request payload

Response

application/json

STP download of trade to fill limit order request

[
  {
    "orderId": "4820276016",
    "tradeId": "FXI9369258100",
    "tradeType": "Spot",
    "tradeDate": "2023-06-02",
    "valueDate": "2023-06-15",
    "maker": false,
    "side": "Buy",
    "status": "Verified",
    "symbol": "EUR/USD",
    "currency": "EUR",
    "customerAccount": "CustomerOrgle1",
    "customerOrg": "CustomerOrg",
    "user": "userName@CustomerOrg",
    "counterparty": "BrokerOrg1",
    "counterpartyLongName": "The Broker Org",
    "counterpartyAccount": "BrokerOrg1LE5",
    "coId": "8932452311944",
    "channel": "API/REST/ESP",
    "executionTime": "2023-06-02 18:31:01,301 +0000",
    "dealtAmount": 1000000,
    "settledAmount": 1097166.9,
    "baseAmount": 1000000,
    "termAmount": 1097166.9,
    "spotRate": 1.0971669,
    "rate": 1.0971669,
    "event": "NEW",
    "channelCategory": "API",
    "upi": "EUR_USD_SPOT",
    "uti": "1234567890AQUSUUINP9349138130"
  }
]

Trade ESP spot

Goal

Prerequisites

Steps

Step 1: Login

Step 2: Get spot prices

Step 3: Place order

Step 4: Query order

Step 5: Download trade

Was this helpful?