API Documentation
Daily Summary Endpoint
GET /api/v1/summary/daily/:exchange_symbol/:date
This endpoint provides a daily summary of market data for all instruments on a given exchange for a specific date. To use this endpoint, provide the exchange symbol and the date in the format YYYY-MM-DD. Responses are available in CSV, JSON, XML, or YAML formats. Simply append .csv, .json, .xml, or .yaml to the URL to specify the format.
Sample Request:
/api/v1/summary/daily/wse/2000-01-05.csv
/api/v1/summary/daily/wse/2000-01-05.json
/api/v1/summary/daily/wse/2000-01-05.xml
/api/v1/summary/daily/wse/2000-01-05.yaml
Instruments Endpoint
GET /api/v1/instruments/:exchange_symbol
This endpoint returns a list of instruments available on a specific exchange. To use this endpoint, provide the exchange symbol. The response includes details such as the instrument name, ISIN, the number of trading days, and the last trading date. Responses are available in CSV, JSON, XML, or YAML formats. Simply append .csv, .json, .xml, or .yaml to the URL to specify the format.
Sample Request:
/api/v1/instruments/wse.csv
/api/v1/instruments/wse.json
/api/v1/instruments/wse.xml
/api/v1/instruments/wse.yaml
History Endpoint
GET /api/v1/history/:country_symbol/:exchange_symbol/:isin_or_name
This endpoint provides historical market data for a given stock. To use this endpoint, provide the country symbol, exchange symbol, followed by either the ISIN or the name of the stock. The system will first try to find the stock by ISIN; if not found, it will search by name. You can also specify optional parameters like start_date and end_date to filter the historical data. Responses are available in CSV, JSON, XML, or YAML formats. Simply append .csv, .json, .xml, or .yaml to the URL to specify the format.
Sample Requests:
/api/v1/history/wse/PLWAWEL00013.csv
/api/v1/history/wse/PLWAWEL00013.json
/api/v1/history/wse/PLWAWEL00013.xml
/api/v1/history/wse/PLWAWEL00013.yaml