Get Top of Book

Get the current top of the book quote for a stocks dataset

get

This method fetches the current top of the book quote received by the live feed subsystem of a specific stocks dataset.

Query parameters

datasetstring · enumOptional

The dataset for which the top of book quote is to be returned

Default: SIPPossible values:

symbolsstringRequired

The (comma separated) set of symbols for which the top of book quotes are to be returned

Responses

200

Indicates the request completed successfully

application/json

statusstringOptional

Indicates whether the request was successful or not. A null value indicates success while a non-null value contains the description of the error encountered.

haltedboolean[]Optional

Indicates whether each corresponding security is currently halted from trading

500

Indicates that an error was encountered during processing of the request

application/json

get

/datafye-api/v1/stocks/live/topofbook

HTTPcURLJavaScriptPython

GET /datafye-api/v1/stocks/live/topofbook?symbols=text HTTP/1.1
Host: api.datafye.local
Accept: */*

{
  "status": "text",
  "quotes": [
    {
      "symbol": "text",
      "exchangeTimestamp": 1,
      "bidExchangeID": 1,
      "bidPrice": 1,
      "bidSize": 1,
      "askExchangeID": 1,
      "askPrice": 1,
      "askSize": 1
    }
  ],
  "halted": [
    true
  ]
}