GET api/Candles/{priceSource}?start={start}&end={end}&externalSymbolId={externalSymbolId}&period={period}

Gets complete candles for the given time span and the given market. The symbol id is an identifier from a price provider, named by the price source parameter. Candles may not be recorded for all periods of time, so the returned candles may not be contiguous. Requests that would result in excessively large data sets will be rejected with a status code of 400. Return data is ordered from oldest to newest.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
priceSource

The source of the prices for the candles. Each price source may use a different symbol id for the same market

PriceSource

Required

start

The inclusive start of the time period for which candles should be returned (in UTC)

date

Required

end

The inclusive end of the time period for which candles should be returned (in UTC). If omitted, the returned candles with cover the time period up until now. Note, if a candle starts before "end" it will be returned, even if it finishes after "end".

date

Required

externalSymbolId

The prices source's symbol id for which candles should be returned

string

Required

period

The period of time (in minutes) that each returned candle should represent

integer

Required

Body Parameters

None

Response Information

Resource Description

CandleResponse
NameDescriptionTypeAdditional information
Content

A collection of candles sorted by start time ascending

Collection of Candle

None

Response Formats

application/json, text/json

Sample:
{
  "Content": [
    {
      "Time": "2000-01-01T00:00:00",
      "Key": "123",
      "Open": 100.0,
      "Close": 200.0,
      "High": 250.0,
      "Low": 50.0
    },
    {
      "Time": "2000-01-01T00:01:00",
      "Key": "123",
      "Open": 100.0,
      "Close": 200.0,
      "High": 250.0,
      "Low": 50.0
    }
  ]
}