SymbolsScope: symbolsData API

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

  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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
  }
]

/symbols/{symbolId}

get

URI Parameters

  • symbolId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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.

/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.

/symbols/{symbolId}/schedule

get

URI Parameters

  • symbolId: required (string)
  • types: (boolean - default: false)

    Show order types

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

    • orderTypes: (object)

      Available order types

      • limit: required (array of Duration)
      • market: required (array of Duration)
      • pegged: required (array of Duration)
      • stop: required (array of Duration)
      • stop_limit: required (array of Duration)

Example:

{
  "intervals": [
    {
      "name": "PreMarket",
      "period": {
        "start": 1481533200000,
        "end": 1481553000000
      }
    },
    {
      "name": "MainSession",
      "period": {
        "start": 1481553000000,
        "end": 1481576400000
      }
    },
    {
      "name": "AfterMarket",
      "period": {
        "start": 1481576400000,
        "end": 1481590800000
      },
      "orderTypes": {
        "limit": [
          "day",
          "good_till_cancel",
          "good_till_time"
        ],
        "market": [
          "day",
          "good_till_cancel",
          "good_till_time"
        ],
        "stop": [
          "day",
          "good_till_cancel",
          "good_till_time"
        ],
        "stop_limit": [
          "day",
          "good_till_cancel",
          "good_till_time"
        ]
      }
    }
  ]
}

HTTP status code 404

Symbol hasn't found or unavailable

ExchangesScope: symbolsData API

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"
  }
]

/exchanges/{exchangeId}

get

URI Parameters

  • exchangeId: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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.

TypesScope: symbolsData API

Collection of available instrument types.

/types

get

HTTP status code 200

Media type: application/json

Example:

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

/types/{type}

get

URI Parameters

  • type: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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.

GroupsScope: symbolsData API

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"
  }
]

/groups/{groupId}

get

URI Parameters

  • groupId: required (string)

HTTP status code 200

Media type: application/json

Items: Symbol list

  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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.

/groups/{groupId}/nearest

get

URI Parameters

  • groupId: required (string)

HTTP status code 200

Media type: application/json

Properties
  • id: required (string)

    Internal symbol id

  • ticker: required (string)

    Exchange ticker

  • name: (string)

    Symbol name

  • description: required (string)

    Symbol description

  • exchange: (string)

    Exchange id where the symbol is traded

  • country: (string)

    Country of symbol's exchange

  • type: required (string)

    Symbol type

  • mpi: required (number)

    Minimum possible increment of symbol price

  • i18n: (string)

    Object with localized descriptions

  • currency: required (string)

    Currency of symbol price

  • group: (string)

    Group of symbol, applicable to Futures and Options

  • expiration: (number)

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

  • 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.

OHLCScope: ohlcData API

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.

Feed streamScope: feedData API

Stream of symbol(s) price updates.

/feed/{symbolIds}

get

URI Parameters

  • symbolIds: required (string)

    Symbol or comma-delimited symbols to request quotes.

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.

Daily changeScope: changeData API

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
  }
]

/change/{symbolIds}

get

URI Parameters

  • symbolIds: required (string)

    Symbol or comma-delimited symbols to request daily change.

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.

CrossratesScope: crossratesData API

Collection of currency crossrates.

/crossrates

get

HTTP status code 200

Media type: application/json

Example:

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

/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.

Trade API

Resources exposed in this section give access to trading and reporting.

Please note, Trade API has different root URI from Market Data API.

OrdersScope: ordersTrade API

/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, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • 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

post

Body

Media type: application/json

Properties
  • account: required (string)
  • instrument: required (string)
  • side: required (one of buy, sell)
  • quantity: required (string)
  • orderType: required (one of market, limit, stop, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • stopPrice: (string)
  • limitPrice: (string)
  • gttExpiration: (string)
  • clientTag: (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, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • 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

/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, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • 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

/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, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • 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

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, stop_limit)
  • duration: required (one of day, fill_or_kill, immediate_or_cancel, good_till_cancel, good_till_time, at_the_opening, at_the_close)
  • 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

Orders & trades streamScope: ordersTrade API

Streaming updates of orders and trades

/stream/orders

get

HTTP status code 200

Media type: application/x-json-stream

Example:

{
  "event": "order",
  "sequence_number": "122",
  "order": {
    "placeTime": "2017-10-18T10:06:51.272Z",
    "orderState": {
      "status": "working",
      "lastUpdate": "2017-10-18T10:08:31.954Z",
      "fills": []
    },
    "id": "6b6847d2-872b-44e6-bc5c-4e77d143a21e",
    "clientTag": "test",
    "orderParameters": {
      "side": "buy",
      "duration": "day",
      "quantity": "2",
      "orderType": "limit",
      "limitPrice": "2",
      "instrument": "TEST_STOCK.TEST"
    },
    "currentModificationId": "030fa3d7-7d64-4806-81ac-cc25b75b55a9",
    "exanteAccount": "VDR1633.001"
  }
}

/stream/trades

get

HTTP status code 200

Media type: application/x-json-stream

Example:

{
  "event": "trade",
  "sequence_number": "62",
  "quantity": "1",
  "order_id": "f0b9d02a-2214-41b0-93d2-96f07dfd894d",
  "price": "100.00234",
  "position": "0",
  "time": "2017-10-18T15:44:46.343Z"
}

User accountsScope: accountsData API

Collection of user accounts.

/accounts

get

HTTP status code 200

Media type: application/json

Items: Accounts list

  • status: required (string)
  • accountId: required (string)

Example:

[
  {
    "accountId": "FAZ7319.001",
    "status": "Full"
  }
]

Account summaryScope: summaryData API

Account summary for selected account id in chosen currency and optionally for the chosen date.

/summary/{account}/{currency}

get

URI Parameters

  • account: required (string)

    Account id

  • currency: required (string)

    Currency

HTTP status code 200

Media type: application/json

Properties
  • account: required (string)
  • currency: required (string)
  • sessionDate: (number)
  • timestamp: required (number)
  • netAssetValue: (number)
  • freeMoney: (number)
  • moneyUsedForMargin: (number)
  • marginUtilization: (number)
  • currencies: required (array of AccountSummary.Currency)

    Items: AccountSummary.Currency

    • code: required (string)
    • value: required (number)
    • convertedValue: (number)
  • positions: required (array of AccountSummary.Instrument)

    Items: AccountSummary.Instrument

    • id: required (string)
    • symbolType: required (string)
    • quantity: required (number)
    • currency: required (number)
    • price: (number)
    • averagePrice: (number)
    • pnl: (number)
    • convertedPnl: (number)
    • value: (number)
    • convertedValue: (number)

Example:

{
  "account": "LIJ6027.001",
  "currencies": [
    {
      "code": "EUR",
      "convertedValue": -2637054.14,
      "value": -2227053.57
    },
    {
      "code": "GBP",
      "convertedValue": -2825670.28,
      "value": -2123035.07
    },
    {
      "code": "JPY",
      "convertedValue": 123062.63,
      "value": 14313136.59
    },
    {
      "code": "USD",
      "convertedValue": -286858.67,
      "value": -286858.67
    }
  ],
  "currency": "USD",
  "freeMoney": 0.0,
  "marginUtilization": 2.0,
  "moneyUsedForMargin": 1206764.12,
  "netAssetValue": -7017599.96,
  "positions": [
    {
      "averagePrice": 99.40231,
      "convertedPnl": -2383.34,
      "convertedValue": -469021.74,
      "currency": "JPY",
      "id": "EUR/JPY.F",
      "pnl": -277200.01,
      "price": 99.91,
      "quantity": -546000,
      "symbolType": "STOCK",
      "value": -54550860.0
    },
    {
      "averagePrice": 77.75,
      "convertedPnl": -208650.0,
      "convertedValue": -441900.0,
      "currency": "USD",
      "id": "LONGCORP.B",
      "pnl": -208650.0,
      "price": 147.3,
      "quantity": -3000,
      "symbolType": "STOCK",
      "value": -441900.0
    },
    {
      "averagePrice": 77.2,
      "convertedPnl": -291745.98,
      "convertedValue": -702745.77,
      "currency": "GBP",
      "id": "UK100.I",
      "pnl": -219200.0,
      "price": 132.0,
      "quantity": -4000,
      "symbolType": "STOCK",
      "value": -528000.0
    },
    {
      "averagePrice": 106.47,
      "convertedPnl": -7387.2,
      "convertedValue": 222588.0,
      "currency": "USD",
      "id": "BRENT.C",
      "pnl": -7387.2,
      "price": 103.05,
      "quantity": 2160,
      "symbolType": "STOCK",
      "value": 222588.0
    }
  ],
  "timestamp": 1512662945000
}

HTTP status code 404

The account is not found

/summary/{account}/{date}/{currency}

get

URI Parameters

  • account: required (string)

    Account id

  • date: (string)

    Date (such as '2011-12-03' or '2011-12-03+01:00')

  • currency: required (string)

    Currency

HTTP status code 200

Media type: application/json

Properties
  • account: required (string)
  • currency: required (string)
  • sessionDate: (number)
  • timestamp: required (number)
  • netAssetValue: (number)
  • freeMoney: (number)
  • moneyUsedForMargin: (number)
  • marginUtilization: (number)
  • currencies: required (array of AccountSummary.Currency)

    Items: AccountSummary.Currency

    • code: required (string)
    • value: required (number)
    • convertedValue: (number)
  • positions: required (array of AccountSummary.Instrument)

    Items: AccountSummary.Instrument

    • id: required (string)
    • symbolType: required (string)
    • quantity: required (number)
    • currency: required (number)
    • price: (number)
    • averagePrice: (number)
    • pnl: (number)
    • convertedPnl: (number)
    • value: (number)
    • convertedValue: (number)

Example:

{
  "account": "LIJ6027.001",
  "currencies": [
    {
      "code": "EUR",
      "convertedValue": -2637054.14,
      "value": -2227053.57
    },
    {
      "code": "GBP",
      "convertedValue": -2825670.28,
      "value": -2123035.07
    },
    {
      "code": "JPY",
      "convertedValue": 123062.63,
      "value": 14313136.59
    },
    {
      "code": "USD",
      "convertedValue": -286858.67,
      "value": -286858.67
    }
  ],
  "currency": "USD",
  "freeMoney": 0.0,
  "marginUtilization": 2.0,
  "moneyUsedForMargin": 1206764.12,
  "netAssetValue": -7017599.96,
  "positions": [
    {
      "averagePrice": 99.40231,
      "convertedPnl": -2383.34,
      "convertedValue": -469021.74,
      "currency": "JPY",
      "id": "EUR/JPY.F",
      "pnl": -277200.01,
      "price": 99.91,
      "quantity": -546000,
      "symbolType": "STOCK",
      "value": -54550860.0
    },
    {
      "averagePrice": 77.75,
      "convertedPnl": -208650.0,
      "convertedValue": -441900.0,
      "currency": "USD",
      "id": "LONGCORP.B",
      "pnl": -208650.0,
      "price": 147.3,
      "quantity": -3000,
      "symbolType": "STOCK",
      "value": -441900.0
    },
    {
      "averagePrice": 77.2,
      "convertedPnl": -291745.98,
      "convertedValue": -702745.77,
      "currency": "GBP",
      "id": "UK100.I",
      "pnl": -219200.0,
      "price": 132.0,
      "quantity": -4000,
      "symbolType": "STOCK",
      "value": -528000.0
    },
    {
      "averagePrice": 106.47,
      "convertedPnl": -7387.2,
      "convertedValue": 222588.0,
      "currency": "USD",
      "id": "BRENT.C",
      "pnl": -7387.2,
      "price": 103.05,
      "quantity": 2160,
      "symbolType": "STOCK",
      "value": 222588.0
    }
  ],
  "timestamp": 1512662945000
}

HTTP status code 404

The account is not found

TransactionsScope: transactionsData API

User transactions.

/transactions

get

Query Parameters

  • uuid: (string)

    uuid v4

  • accountId: (string)

    Account Id

  • symbolId: (string)

    Symbol Id

  • asset: (string)

    Asset

  • operationType: (array of string)

    Operation Type

  • offset: (integer)

    Offset

  • limit: (integer)

    Limit

  • order: (string - default: ASC)

    Order

  • fromDate: (string)

    Specify starting timestamp in ISO format

  • toDate: (string)

    Specify ending timestamp in ISO format

  • orderId: (string)

    uuid v4

  • orderPos: (integer)

    Order Pos

HTTP status code 200

Media type: application/json

Items: Transaction list

  • id: required (number)
  • operationType: required (string)
  • timestamp: required (number)
  • sum: required (number)
  • asset: required (string)

Example:

[
  {
    "asset": "EUR",
    "id": 86894573,
    "operationType": "FUNDING/WITHDRAWAL",
    "sum": 1000000.0,
    "when": 1510756109697
  }
]

HTTP status code 400

The specified query parameters have an incorrect format