Trade on behalf of

Execute a spot trade with ESP rates on behalf of another organization, from login and requesting rates to downloading the done trade.

This guide uses the Get fixed-period market data workflow for tradable rates, but you can substitute the Get spot prices workflow in Step 2.

• Your REST API app.
• Integral API login with trading permission.
• Your organization provisioned with at least one provider who streams ESP spot prices.
• A customer organization that you trade on behalf of.

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.

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

Use the Get market data endpoint.

Use the rateId attribute of the JSON response in the next step.

See the related Get fixed-period market data tutorial.

const query = new URLSearchParams({
  id: 'string',
  org: 'BNK1-4HOrg',
  symbol: 'EUR/USD',
  symbols: 'EUR/USD,USD/JPY',
  date: '2024-10-24',
  tenor: 'SPOT',
  timeWindow: '1500-1700'
}).toString();

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

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

Use the Place order endpoint.

See the related Place an order (previously quoted) tutorial.

These parameters are required on the request body: org, account, coId, type, side, symbol, size, price, currency, timeInForce, rateId.

• rateId contains the rateId from the rate in the market data.
• org contains the organization ID of the organization you are trading on behalf of.
• account contains the account ID (legal entity) of the behalf-of organization.

{
  "coId": "pq11233",
  "rateId": "4HProduct|2022-11-14|0800-1200|EURUSD|SPOT",
  "currency": "EUR",
  "size": 9000000,
  "type": "PQ",
  "price": 1.1652,
  "side": "Buy",
  "symbol": "EUR/USD",
  "timeInForce": "FOK"
}

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.

No request payload

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 find your trade in the array of returned trades.

No request payload