latestSwagger 2.02026-08-1274120326.8 KB

3a995f316cda

Data

Ticker by Levels for Date

This is the "Levels" query for a single date where the qualifier here is being simplified to "Levels" (also called Qualifier_Code). This can refer to any geographic qualifier level including but not limited to: XMKT, KMA, NATIONAL, STATE, COUNTY, or ZIP3. For more information, please feel free to use the LookUp API call to find more levels available for searching. A ticker full name would be OTRI.ATL, which will be entered OTRI/ATL into the URL, while Date should be in the form of 'yyyy-MM-dd'. For better understanding on terminology or how to use this API, please feel free to navigate to the help page or contact us. An example URL for this API call would be: https://api.sonar.surf/data/levels/OTRI/NATIONAL/2018-02-20

get/Data/levels/{index}/{level}/{date}

Path parameters

Indexstring required

This is the ticker index and specifies the index to look up. In the example above, OTRI would be the Ticker Index.

Levelstring required

This is the ticker qualifier, designated here as level. In the example above, XMKT would be the Ticker Qualifier Level. For more information, browse the LookUp section and get the full list of supported level qualifiers.

Datestring date-time required

This is the specific date that matches the given ticker. In the example above, 2018-02-20 would be the Specific Date (yyyy-MM-dd).

Headers

x-api-versionstring

Response

Returns List of Index Data

data_Timestampstring date-time
data_Valuenumber double
indexstring
qualifierstring
qualifier_Codestring