A Get Store Locations request takes a text input and returns store location data. The input can be a company refence such as a ticker, companyID, or Figi Composite ID. The input can also include location based text, such a zip code or state.
| Parameter | Example | Desc |
| apiKey | simplekey | (*Required) The API Key for your subscription |
| companyids | cw_22447 | The Company ID(s) used to export company records (example: cw_22447) |
| startDate | 2018-12-1 | The Start Date of your data export (example: 2018-12-1) |
| endDate | 2020-01-2 | The End Date of your data export (example: 2020-03-2) |
| states | ny | The State code(s) that are used in your data export (example: ny) |
| zipCodes | 10954 | The Zip Code(s) that are used in your data export (example: 10954) |
| status | added | The Status of the last run per record (added, updated and deleted) |
| Ticker | aap | The Ticker of the company you are searching for |
| ChangeTracking | true | Whether you would like to return change tracking results or not |
| Figi_Composite | BBG000F7RCJ1 | The Open FIGI Composite ID of the company |
| fileName | stores.csv | The File Name of your exported data |
| format | csv | The format of your data export (json or csv) |
| compress | false | Whether you would like the file to be compressed or not (csv only - true or false) |
Retrieve store location summary data using a text input or all data subscribed to your API Key. You can provide an input of company reference fields such as the Ticker or Figi Composite ID.
| Parameter | Example | Desc |
| apiKey | simplekey | (*Required) The API Key for your subscription |
| ticker | aap | The Ticker of the company you are searching for |
| figi_composite | BBG000F7RCJ1 | The Open FIGI Composite ID of the company you are searching for |
| fileName | store_summary.csv | The File Name of your exported data |
| format | csv | The format of your data export (json or csv) |
| compress | false | Whether you would like the file to be compressed or not (csv only - true or false) |
Retrieve the list of companies you subscribe to with your API Key
| Parameter | Example | Desc |
| apiKey | simplekey | (*Required) The API Key for your subscription |
| fileName | company_list.csv | The File Name of your exported data |
| format | csv | The format of your data export (json or csv) |
| compress | false | Whether you would like the file to be compressed or not (csv only - true or false) |
Retrieve company summary data using a text input or all data subscribed to your API Key. You can provide an input of company reference fields such as the Ticker or Figi Composite ID.
| Parameter | Example | Desc |
| apiKey | simplekey | (*Required) The API Key for your subscription |
| ticker | aap | The Ticker of the company you are searching for |
| figi_composite | BBG000F7RCJ1 | The Open FIGI Composite ID of the company you are searching for |
| fileName | company_summary.csv | The File Name of your exported data |
| format | csv | The format of your data export (json or csv) |
| compress | false | Whether you would like the file to be compressed or not (csv only - true or false) |
Retrieve the list of ticker data and history that you subscribe to with your API Key
| Parameter | Example | Desc |
| apiKey | simplekey | (*Required) The API Key for your subscription |
| fileName | ticker_history.csv | The File Name of your exported data |
| format | csv | The format of your data export (json or csv) |
| compress | false | Whether you would like the file to be compressed or not (csv only - true or false) |
You can also access our live PostMan documentation available here.
Comments
0 comments