Configure API: Creating an API for Order Route/Price Feed

This manual consists of detailed steps to add a new API for Order Route / Price Feed.

Instructions

1. Navigate to the Configure API window via Tools on the BackOffice panel.
   
   
   
2. To add an API, click "Add" and type the desired name of the API connection.
   Once the API is added, fill in the relevant fields.
   
   
   
3. After making the necessary changes, click "Apply" to save the API.
   Tick the "Load" box to load the API and select "Server Action" to restart the server if needed.
   

Note: Unchecking "Load" would cause the API to be disconnected from the brokerage account after the server restarts. 

Information for the API:

• User ID, Password, Host Address, Price Address, Price Port, Host Port, Broker ID: Taken from the broker
• Cancel Limit Group: If the APIs are set to the same group, all accounts that are linked to the API would be limited to the same cancel limit.    
• Anti Self-Match Group: If the APIs are set to the same group, all accounts that are linked to to the API would not be able to self-match within each other.
• Price Rank: If multiple APIs are loaded, price rank could be used to decide which market data should be read. The number that is set the highest would be read first.
• Grp Permission: Limit sub-admin to use only the selected APIs. for example, setting the grp permission to Tradex;Test would allow the sub-admin, Tradex and Test, to see the API.
• Client Type: Default set as C
• Application ID/License ID: Special type of OTC authorization code
• Filter: To activate the internal match function for that API
• Delete: Once the "delete" checkbox for the API is ticked, the API information would be deleted and it would take effect after the server restart
• Trader Location: For remarks purposes
• Default TA: FOR OTC settings
• More Config: More Config could be used to set the following:
  • Upstreams for Chinese Exchanges need to add the following line: brokerName=（Name of Broker Company) eg: brokerName=SimNow
  • Internal Match: internal_match=COMEX-G\GCE;0
  • Contract Mapping: map=SGX\UC→SGX\ZUC
  • Price rank based on contract: price_rank=SGX\ZUC;12 [Note: only based on contracts, do not set it for exchange only]

Important Notes

• Only super-admin is authorized to update those fields of this upstream:
  • APIType (The type of connection usage)
  • ApplicationID (Only applicable to specific APIType)
  • License (Only applicable to specific APIType)
  • ClientType (Only applicable to specific APIType default kept as C)
  • CancelLimitGroup (To group the respective API for cancel limit calculation)
  • AntiSelfMatchGroup (To group the respective API for Anti-Self Match Prevention)
  • GroupPermission (For the relevant Sub-admin grouping to make view and amend this APIID)
  • Filter
  • Config (More Config）
  • PriceFeedRank (The API with the highest numeric number will be prioritized for Price Feed)

• When a sub-admin user with specify grouping (The 1st group inside its [GroupPermission] column) logged into BackOffice, it will be able to view this upstream and update the upstream’s info - only limited to these fields:
  • AccountID
  • Password
  • Load
  • ToDelete
  • TraderLocation
  • DefaultTraderAccount
  • HostAddress
  • HostPort
  • PriceAddress
  • PricePort
  • BrokerID
    
    

Related articles