Place an order (at best)

Place an at-best order and query its progress through the order workflow.

This guide uses the at-best order type: you submit the order to get done at the best rate available. Your priority is trade execution over price.

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

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 Place order endpoint.

You must send the following with your order:

• type=AtBest
• timeInForce=FOK
• valueDate

{
  "coId": "8932452311944",
  "type": "Limit",
  "side": "Buy",
  "symbol": "EUR/USD",
  "currency": "EUR",
  "size": 1000000,
  "price": 1.0971678,
  "timeInForce": "IOC"
}

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

Use one of the following endpoints:

• Query order (server ID)
• Query order (client ID or all active orders)

The diagram shows the values returned in the status field in the response and their context in the order workflow.

const id = '4820276016';
const resp = await fetch(
  `/v2/orders/${id}`,
  {
    method: 'GET',
    headers: {
      SSO_TOKEN: 'YOUR_API_KEY_HERE'
    }
  }
);

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