search

Instruments

This API part provides info on financial instruments

Please note that this section provides data on financial instruments themselves. If you want to find out the list of instruments that are available for trading with the specified account, you should use the GET /accounts/{accountId}/instruments request (see Account management section).

circle-check

A full list of available methods and their parameters can be found here:

https://sandbox-api.traderevolution.com/traderevolution/v1/swagger-ui/index.html#/Instrumentsarrow-up-right

hashtag
Financial instrument info

GET/traderevolution/v1/instruments/{tradableInstrumentId}

This method allows requesting detailed information about a trading instrument. Please note that the tradable instrument ID (not the regular instrument ID) must be specified in the request. It can be received by using theGET/accounts /{accountId}/instruments method.

Query/Path

Name
Type
Description

accountId*

integer/query

Identifier of the account for which the info is returned.

locale

string/query

Language identifier. Available values: ar, en, es, fr, ja, ko, pl, pt, ru, tr, ua, zh_sm, zh_tr

tradableInstrumentId*

integer/path

Tradable instrument ID by which the info on the required instrument will be returned.

CURL

curl -X GET "https://sandbox-api.traderevolution.com/traderevolution/v1/instruments/11681?accountId=3243563" -H "accept: application/json" -H "Authorization: Bearer eyJraWQiOiI3NDhlZjYwZS1mYTNlLTRmYjAtOWQyYy1kYzBhNGE3ZjZjZmEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJpcnluY...31VnjWKOwPMoOCKbApKkUmfFVDFdQXjhd4tm41O50y6hFwi2FIVHhnQz7iHDBPNg"

Response

{
  "d": {
    "name": "ETHUSD",
    "description": "ther coin - United States dollar",
    "type": "CRYPTO",
    "tradingExchange": "Crypto",
    "marketDataExchange": "Crypto",
    "country": null,
    "isin": "5262564",
    "industry": null,
    "sector": null,
    "marketCap": null,
    "logoUrl": null,
    "localizedName": "ETHUSD",
    "settlementSystem": "Immediate",
    "tickSize": [
      {
        "leftRangeLimit": null,
        "tickSize": 0.01
      }
    ],
    "tickCost": [
      {
        "leftRangeLimit": null,
        "tickCost": 1
      }
    ],
    "baseCurrency": "USD",
    "quotingCurrency": "USD",
    "symbolStatus": "FULLY_OPEN",
    "lotSize": 1,
    "lotStep": 1e-8,
    "minLot": 1,
    "maxLot": null,
    "maxLotInCash": null,
    "bettingCurrency": null,
    "betStep": null,
    "betSize": null,
    "tradeSessionId": 7943,
    "contractMonth": null,
    "firstTradeDate": null,
    "lastTradeDate": null,
    "noticeDate": null,
    "settlementDate": null,
    "deliveryStatus": null,
    "exerciseStyle": null,
    "strikePrice": null,
    "strikeType": null,
    "strikeVersion": null,
    "tradeSessionStatusId": 6133,
    "barSource": "BID",
    "hasIntraday": true,
    "hasDaily": true,
    "swap": {
      "swapBuy": 2.25,
      "swapSell": 1.5,
      "swapMeasure": 1,
      "swapComment": "Standard plan applied"
    }
  },
  "s": "ok"
}

In the response, you will get detailed data about the selected instrument. Standard errors can be received as well. If some parameter is absent (not cofigured) then it will be returned as null.

circle-check

A detailed description of this method can be found here:

https://sandbox-api.traderevolution.com/traderevolution/v1/swagger-ui/index.html#/Instruments/getInstrumentDetailsarrow-up-right

hashtag
Get trade sessions

GET/traderevolution/v1/sessions

This endpoint allows getting a list of all trading sessions available on this server. Please note that you can return both, a specific session by ID, or all sessions at once. The response will contain an array of objects where each object contains information on one trade session.

Query

Name
Type
Description

sessionId

integer

Session identifier. Fill this parameter when you need info on a concrete session.

СURL (example for ID=7943)

Response

As a result, you will get a data object that contains the sessions array, where each object contains full information about each trading session. The example shows one trade session returned by its ID. Each session period is described separately, holidays can be found at the beginning of the array as well, and trading on these days should be configured independently (you can see shortened day settings on a holiday in the example).

Standard errors can be received as well. If some setting is not configured, the null value will be returned for it.

circle-check

A detailed description of this method can be found here:

https://sandbox-api.traderevolution.com/traderevolution/v1/swagger-ui/index.html#/Instruments/getTradeSessionarrow-up-right

hashtag
Get trade session statuses

GET/traderevolution​/v1​/sessionStatuses

This endpoint allows getting the list of available trade session statuses. Trade session status is the entity that determines trading permissions that are applied to this or that trade session. Trade session status defines the list of allowed: trade operations, order types, off-market order types, and the ability to send opening orders.

Query

Name
Type
Description

sessionStatusId

integer

Trade session status ID. Fill this parameter when you need info on a concrete status.

CURL (example for status with ID=7345)

Response

The following parameters are returned in the response, where 1=Allowed, 0=Forbidden:

As a result, you will get a data object that contains the statuses array, where each object contains full information about each status. The example shows a specific response for status by its ID.

Standard errors can be received as well.

circle-check

A detailed description of this method can be found here:

https://sandbox-api.traderevolution.com/traderevolution/v1/swagger-ui/index.html#/Instruments/getSessionStatusarrow-up-right

PreviousConfig (Basic settings & Accesses)NextMarket data

Last updated