Stocks
You can use these APIs to get stock information.
All Stocks
Retrieve a list of all stocks available in the specified region (US in this case).
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| region | Region code (tr, us) | query | string | |
| page | Page number | 0 | query | number |
| pageSize | Page size | 10 | query | number |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Details By ID
Retrieves detailed information about a specific stock using its unique identifier. This endpoint is useful for obtaining comprehensive data about a particular stock, including its type, class, and other pertinent details.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| locale | Locale code (tr, en) | query | string | |
| id | Unique identifier | 6203d1ba1e6748752755559a | path | string |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Details By Symbol
Retrieves detailed information about a specific stock using its symbol, asset class and region. This endpoint is useful for obtaining comprehensive data about a particular stock, including its type, class, and other pertinent details.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| locale | Locale code (tr, en) | query | string | |
| symbol | Symbol of the stock. | AAPL | query | string |
| region | Region code (tr, us) | query | string | |
| asset_class | Asset class (equity, stock) | query | string |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Historical Price
Retrieves the historical price of a stock in a specified region. This endpoint is useful for investors looking to track the price of a stock over time.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| region | Region code (tr, us) | query | string | |
| symbols | Comma-separated list of stock symbols | AKBNK,ASELS | query | array |
| keys | Comma-separated list of keys for which statistics are required. | query | array |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Historical Price with Custom Date range and Interval
Retrieves the historical price of a stock in specificed time range and interval. This endpoint can be useful if you want to increase the frequency of the data you receive.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| stock | It can be either stock symbol or stock id you got from other endpoints. | AKBNK | query | string |
| region | Region code (tr, us) | query | string | |
| fromDate | Start date of the data range. | query | date | |
| toDate | Start date of the data range. | query | date | |
| interval | Interval of the datapoints. | query | string | |
| detail | If true, also returns the unadjusted price data even if stock is split or other corporate actions are applied. | query | boolean |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Tick Rules and Limits
You can retrieve the tick rules for creating orderbook and also the upper and lower price limits for a stock.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| region | Region code (tr, us) | query | string | |
| symbol | Symbol of the stock. | AKBNK | query | string |
Response
(Note: Actual response can be different length and other fields may be present)
Stock Restrictions
You can retrieve the restrictions for a stock.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| region | Region code (tr, us) | query | string | |
| symbol | Symbol of the stock. | AKBNK | query | string |
Response
(Note: Actual response can be different length and other fields may be present)