SymbolsScope: symbols

The collection of the available trading symbols. Please note that the symbol list is subject to change, and it needs to be updated from time to time.

/symbols

get

HTTP status code 200

Media type: application/json

Items: Symbol list

  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

Example:

[  {
    "id": "OZL.CBOT.U2017.P30_5",
    "ticker": "OZL",
    "name": "Soybean Oil",
    "description": "Options On Soybean Oil Futures Sep 2017 PUT 30.5",
    "exchange": "CBOT",
    "type": "OPTION",
    "mpi": 5e-05,
    "currency": "USD",
    "group": "OZL",
    "expiration": 1503619200000,
    "optionData": {
      "right": "PUT",
      "strikePrice": 30.5
    }
  },
  {
    "id": "OSIS.NASDAQ",
    "ticker": "OSIS",
    "name": "OSI Systems",
    "description": "OSI Systems",
    "exchange": "NASDAQ",
    "type": "STOCK",
    "mpi": 0.01,
    "currency": "USD"
  },
  {
    "id": "SU24018RMFS2.RUB",
    "ticker": "SU24018RMFS2",
    "name": "OFZ 24018",
    "description": "OFZ 24018",
    "type": "BOND",
    "mpi": 0.0001,
    "currency": "RUB",
    "expiration": 1514332800000
  }
]

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/symbols/{symbolId}

get

URI Parameters

  • symbolId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

HTTP status code 404

Symbol hasn't found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/symbols/{symbolId}/specification

get

URI Parameters

  • symbolId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • leverage: required (number)

    Leverage rate available for this instrument. For instance, 0.2 stands for leverage 1:5.

  • lotSize: required (number)

    Minimum lot size on exchange (may be optional for some exchanges)

  • contractMultiplier: required (number)

    Trade amount should be a multiplier of this value, mostly for Futures and Options

  • priceUnit: required (number)
  • units: required (string)

    Units of measurement

Example:

{
  "leverage": 0.2,
  "lotSize": 1,
  "contractMultiplier": 1,
  "priceUnit": 1,
  "units": "Shares"
}

HTTP status code 404

Symbol hasn't found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/symbols/{symbolId}/schedule

get

URI Parameters

  • symbolId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • intervals: required (array of items)

    Items: items

    • name: required (string)

      Trading session name. May be PreMarket, AfterMarket or MainSession / Online

    • period: required (object)
      • start: required (number)

        Session start timestamp in ms

      • end: required (number)

        Session finish timestamp in ms

Example:

{
  "intervals": [
    {
      "name": "PreMarket",
      "period": {
        "start": 1481533200000,
        "end": 1481553000000
      }
    },
    {
      "name": "MainSession",
      "period": {
        "start": 1481553000000,
        "end": 1481576400000
      }
    },
    {
      "name": "AfterMarket",
      "period": {
        "start": 1481576400000,
        "end": 1481590800000
      }
    }
  ]
}

HTTP status code 404

Symbol hasn't found or unavailable

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

ExchangesScope: symbols

Collection of available exchanges.

/exchanges

get

HTTP status code 200

Media type: application/json

Items: Exchange list

  • id: required (string)

    Exchange internal id

  • name: required (string)

    Full exchange name

  • country: required (string)

    Exchange country'

Example:

[
  {
    "id": "NASDAQ",
    "name": "NASDAQ: National Association of Securities Dealers Automated Quotations",
    "country": "US"
  }
]

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/exchanges/{exchangeId}

get

URI Parameters

  • exchangeId: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

HTTP status code 404

Specified exchange has not found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

TypesScope: symbols

Collection of available instrument types.

/types

get

HTTP status code 200

Media type: application/json

Example:

[
  {
    "id": "FUTURE"
  },
  {
    "id": "BOND"
  },
  {
    "id": "STOCK"
  },
  {
    "id": "OPTION"
  }
]

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/types/{type}

get

URI Parameters

  • type: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

HTTP status code 404

Specified type has not found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

GroupsScope: symbols

Some symbols can be grouped by their underlying asset. For instance, futures on Brent Crude Oil will have group B.ICE.

/groups

get

HTTP status code 200

Media type: application/json

Items: Group list

  • group: required (string)

    Group id

  • name: (string)

    Group title

  • types: required (array of )

    List of symbol types in group

  • exchange: (string)

    Exchange id where group is traded

Example:

[
  {
    "group": "NG",
    "name": "Henry Hub Natural Gas",
    "types": [ "FUTURE" ],
    "exchange": "NYMEX"
  },
  {
    "group": "GDX",
    "name": "Market Vectors Gold Miners ETF",
    "types": [ "OPTION" ],
    "exchange": "CBOE"
  }
]

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/groups/{groupId}

get

URI Parameters

  • groupId: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

HTTP status code 404

Specified group has not found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/groups/{groupId}/nearest

get

URI Parameters

  • groupId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • description: required (string)

    Symbol description

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • mpi: required (number)

    Minimum possible increment of symbol price

  • name: (string)

    Symbol name

  • expiration: (number)

    Expiration timestamp in ms, applicable to Futures, Options and Bonds

  • ticker: required (string)

    Exchange ticker

  • type: required (string)

    Symbol type

  • currency: required (string)

    Currency of symbol price

  • id: required (string)

    Internal symbol id

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • i18n: (string)

    Object with localized descriptions

  • optionData: (object)
    • right: required (one of CALL, PUT)
    • strikePrice: required (number)

      Strike price of the option

HTTP status code 404

Specified group has not found or unavailable or contains no Futures.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

OHLCScope: ohlc

OHLC stands for Open-High-Low-Close — candles — and can be used to build candlestick charts. Several aggregation intervals are available.

/ohlc/{symbolId}/{duration}

get

URI Parameters

  • symbolId: required (string)
  • duration: required (one of 60 (1 min), 300 (5 min), 600 (10 min), 900 (15 min), 3600 (1 hour), 21600 (6 hours), 86400 (1 day))

    Aggregation interval in seconds

Query Parameters

  • from: (number)

    Specify starting timestamp in ms

  • to: (number)

    Specify ending timestamp in ms

  • size: (integer - default: 60)

    Specify maximum amount of candles to retrieve

HTTP status code 200

Media type: application/json

Items: OHLC list

  • timestamp: required (number)
  • open: required (number)
  • high: required (number)
  • low: required (number)
  • close: required (number)

Example:

[
  {
    "timestamp": 1481572800000,
    "open": 112.975,
    "high": 113.105,
    "low": 112.935,
    "close": 112.965
  },
  {
    "timestamp": 1481569200000,
    "open": 112.885,
    "high": 112.935,
    "low": 112.725,
    "close": 112.935
  },
  {
    "timestamp": 1481565600000,
    "open": 112.915,
    "high": 113.135,
    "low": 112.855,
    "close": 112.935
  }
]

HTTP status code 404

Requested symbol has not found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

Feed streamScope: feed

Stream of symbol(s) price updates.

/feed/{symbolIds}

get

URI Parameters

  • symbolIds: required (string)

    Symbol or comma-delimited symbols to request quotes.

    Examples:

    MSFT.NASDAQ,AAPL.NASDAQ,GAZP.MICEX

Headers

  • Accept: (string - default: text/event-stream)

    Specify stream format: text/event-stream or application/x-json-stream.

    text/event-stream is standard media-type for Server-Sent Events (SSE). For more information on this please refer to https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events

    Please note today there is no way to pass headers (like Authorization) in browser using SSE, so you need to use token query parameter to pass authentication token.

    application/x-json-stream is just newline delimited json stream.

HTTP status code 200

Media type: text/event-stream

Example:

id: 1
data:

id: 2
data: {"timestamp":1481643841200,"symbolId":"AAPL.NASDAQ","bid":115.3,"ask":115.31}

id: 3
data: {"timestamp":1481643846625,"symbolId":"AAPL.NASDAQ","bid":115.3,"ask":115.32}

Media type: application/x-json-stream

Example:

{"timestamp":1481643866925,"symbolId":"AAPL.NASDAQ","bid":115.21,"ask":115.22}
{"timestamp":1481643912200,"symbolId":"AAPL.NASDAQ","bid":115.3,"ask":115.31}
{"timestamp":1481643963900,"symbolId":"AAPL.NASDAQ","bid":115.29,"ask":115.3}
{"timestamp":1481643973550,"symbolId":"AAPL.NASDAQ","bid":115.33,"ask":115.34}
{"timestamp":1481643977025,"symbolId":"AAPL.NASDAQ","bid":115.31,"ask":115.32}
{"timestamp":1481644016325,"symbolId":"AAPL.NASDAQ","bid":115.25,"ask":115.26}

HTTP status code 404

No symbols were found or available.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

Daily changeScope: change

Collection of daily change data.

/change

get

HTTP status code 200

Media type: application/json

Items: DailyChange list

  • symbolId: required (string)

    Related symbol id

  • basePrice: required (number)

    Symbol price at the end of last day (UTC)

  • dailyChange: required (number)

    Absolute daily change of the price at the moment of request

Example:

[
  {
    "symbolId": "HINT.LSE",
    "basePrice": 1.45625,
    "dailyChange": 0.00625
  },
  {
    "symbolId": "REP.ES",
    "basePrice": 12.93,
    "dailyChange": -0.2475
  },
  {
    "symbolId": "1161.HKEX",
    "basePrice": 0.58,
    "dailyChange":0.005
  }
]

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/change/{symbolIds}

get

URI Parameters

  • symbolIds: required (string)

    Symbol or comma-delimited symbols to request daily change.

    Examples:

    MSFT.NASDAQ,AAPL.NASDAQ,GAZP.MICEX

HTTP status code 200

Media type: application/json

Items: DailyChange list

  • symbolId: required (string)

    Related symbol id

  • basePrice: required (number)

    Symbol price at the end of last day (UTC)

  • dailyChange: required (number)

    Absolute daily change of the price at the moment of request

HTTP status code 404

No symbols were found or available.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

CrossratesScope: crossrates

Collection of currency crossrates.

/crossrates

get

HTTP status code 200

Media type: application/json

Example:

{
  "currencies": [
    "USD",
    "RUB",
    "NZD",
    "NOK",
    "EUR"
  ]
}

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/crossrates/{from}/{to}

get

URI Parameters

  • from: required (string)

    First currency in crossrate pair

  • to: required (string)

    Second currency in crossrate pair

HTTP status code 200

Media type: application/json

Properties
  • pair: required (string)
  • rate: required (number)

    Current crossrate

  • symbolId: (string)

    Optional symbol id, which can be used to request history or subscribe to feed

Example:

{
  "pair": "EUR/USD",
  "symbolId": "EUR/USD.EXANTE",
  "rate": 1.0622
}

HTTP status code 404

Requested pair has not found or unavailable.

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

OrdersScope: orders

/orders

get

Query Parameters

  • limit: (integer - default: 10)

    The limit for max items of the order list

  • account: (string)

    The account list

  • from: (string)

    Specify starting timestamp in ISO format

  • to: (string)

    Specify ending timestamp in ISO format

HTTP status code 200

Return the list of trading orders

Media type: application/json

Items: Order list

  • id: required (string)
  • placeTime: required (string)
  • lastUpdate: required (string)
  • currentModificationId: required (string)
  • exanteAccount: required (string)
  • instrument: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • status: required (one of created, accepted, placing, working, cancelled, pending, filled, rejected)
  • fills: required (array of items)

    Items: items

    • time: required (object)
      • chronology: required (object)
        • zone: required (object)
          • id: required (string)
          • fixed: required (boolean)
      • millis: required (integer)
      • zone: required (object)
        • id: required (string)
        • fixed: required (boolean)
      • beforeNow: required (boolean)
      • equalNow: required (boolean)
      • afterNow: required (boolean)
    • quantity: required (string)
    • price: required (string)
    • position: required (number)
  • clientTag: required (string)
  • stopPrice: required (string)
  • limitPrice: required (string)
  • gttExpiration: required (string)
  • reason: required (string)

HTTP status code 400

The query parameters do not have correct format

HTTP status code 500

Internal server error

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    
post

Body

Media type: application/json

Properties
  • instrument: required (string)
  • clientTag: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • account: required (string)
  • stopPrice: required (string)
  • side: required (one of buy, sell)
  • limitPrice: required (string)
  • quantity: required (string)
  • gttExpiration: required (string)

HTTP status code 201

Media type: application/json

Properties
  • id: required (string)
  • placeTime: required (string)
  • lastUpdate: required (string)
  • currentModificationId: required (string)
  • exanteAccount: required (string)
  • instrument: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • status: required (one of created, accepted, placing, working, cancelled, pending, filled, rejected)
  • fills: required (array of items)

    Items: items

    • time: required (object)
      • chronology: required (object)
        • zone: required (object)
          • id: required (string)
          • fixed: required (boolean)
      • millis: required (integer)
      • zone: required (object)
        • id: required (string)
        • fixed: required (boolean)
      • beforeNow: required (boolean)
      • equalNow: required (boolean)
      • afterNow: required (boolean)
    • quantity: required (string)
    • price: required (string)
    • position: required (number)
  • clientTag: required (string)
  • stopPrice: required (string)
  • limitPrice: required (string)
  • gttExpiration: required (string)
  • reason: required (string)

HTTP status code 400

Order placing parameters are not correct

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/orders/active

get

Query Parameters

  • limit: (integer - default: 10)

    The limit for max items of the order list

  • account: (string)

    The account list

  • instrument: (string)

    The instrument identifier

HTTP status code 200

Return the list of trading orders

Media type: application/json

Items: Order list

  • id: required (string)
  • placeTime: required (string)
  • lastUpdate: required (string)
  • currentModificationId: required (string)
  • exanteAccount: required (string)
  • instrument: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • status: required (one of created, accepted, placing, working, cancelled, pending, filled, rejected)
  • fills: required (array of items)

    Items: items

    • time: required (object)
      • chronology: required (object)
        • zone: required (object)
          • id: required (string)
          • fixed: required (boolean)
      • millis: required (integer)
      • zone: required (object)
        • id: required (string)
        • fixed: required (boolean)
      • beforeNow: required (boolean)
      • equalNow: required (boolean)
      • afterNow: required (boolean)
    • quantity: required (string)
    • price: required (string)
    • position: required (number)
  • clientTag: required (string)
  • stopPrice: required (string)
  • limitPrice: required (string)
  • gttExpiration: required (string)
  • reason: required (string)

HTTP status code 400

The query parameters do not have correct format

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    

/orders/{id}

get

URI Parameters

  • id: required (string)

    Order identifier

HTTP status code 200

Return the trading order

Media type: application/json

Properties
  • id: required (string)
  • placeTime: required (string)
  • lastUpdate: required (string)
  • currentModificationId: required (string)
  • exanteAccount: required (string)
  • instrument: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • status: required (one of created, accepted, placing, working, cancelled, pending, filled, rejected)
  • fills: required (array of items)

    Items: items

    • time: required (object)
      • chronology: required (object)
        • zone: required (object)
          • id: required (string)
          • fixed: required (boolean)
      • millis: required (integer)
      • zone: required (object)
        • id: required (string)
        • fixed: required (boolean)
      • beforeNow: required (boolean)
      • equalNow: required (boolean)
      • afterNow: required (boolean)
    • quantity: required (string)
    • price: required (string)
    • position: required (number)
  • clientTag: required (string)
  • stopPrice: required (string)
  • limitPrice: required (string)
  • gttExpiration: required (string)
  • reason: required (string)

HTTP status code 400

The specified order identifier does not have correct format

HTTP status code 404

The order is not found

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ
    
post

URI Parameters

  • id: required (string)

    Order identifier

Body

Media type: application/json

Properties
  • action: required (one of replace, cancel)
  • parameters: required (object)
    • quantity: required (string)
    • limitPrice: required (string)
    • stopPrice: required (string)

HTTP status code 200

Order action is accepted

Media type: application/json

Properties
  • id: required (string)
  • placeTime: required (string)
  • lastUpdate: required (string)
  • currentModificationId: required (string)
  • exanteAccount: required (string)
  • instrument: required (string)
  • orderType: required (one of market, limit, stop, stoplimit)
  • duration: required (one of day, fillorkill, immediateorcancel, goodtillcancel, goodtilltime, attheopening, attheclose)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • status: required (one of created, accepted, placing, working, cancelled, pending, filled, rejected)
  • fills: required (array of items)

    Items: items

    • time: required (object)
      • chronology: required (object)
        • zone: required (object)
          • id: required (string)
          • fixed: required (boolean)
      • millis: required (integer)
      • zone: required (object)
        • id: required (string)
        • fixed: required (boolean)
      • beforeNow: required (boolean)
      • equalNow: required (boolean)
      • afterNow: required (boolean)
    • quantity: required (string)
    • price: required (string)
    • position: required (number)
  • clientTag: required (string)
  • stopPrice: required (string)
  • limitPrice: required (string)
  • gttExpiration: required (string)
  • reason: required (string)

HTTP status code 400

Order modification parameters are not correct

Secured by basic

Secured by JWT

Headers

  • Authorization: required (string)

    Used to send a valid JWT as a Bearer.

    Examples:

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ