Custom Themes
Custom Themes are a great way to compile your own list of stocks to provide your users. Create your own themes and display them your platform with a nice UI.
Custom Themes
Get a list of all your custom themes. Pass the locale to retrieve with localized data. Region is optional, if not provided, only custom themes for that region are returned.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| locale | Locale code (tr, en) | query | string | |
| region | Region code (tr, us) | query | string |
Response
(Note: Actual response can be different length and other fields may be present)
Custom Theme Detail
Retrieve detailed information about a specific theme you created. Pass the locale to retrieve with localized data. You can also pass in `price_change` for the `sortBy` parameter to sort the stocks by daily price change percent.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| id | Unique identifier | 6256b0647d0bb100123effa7 | path | string |
| locale | Locale code (tr, en) | query | string | |
| sortBy | Sort the stocks in a collection by a specific field. Currently only supports `price_change`. | query | string |
Response
(Note: Actual response can be different length and other fields may be present)
Create New Custom Theme
Create a new custom theme with the specified data.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| title | Localized title for a custom theme. | { "en": "Rising Stocks", "tr": "Yükselen Hisseler" } | body | object |
| description | Localized description for a custom theme. | { "en": "Recently rising stocks.", "tr": "Son zamanlarda yükselen hisseler." } | body | object |
| stocks | List of stock IDs as string | ["61dd0d4b0ec2114146342f69","61dd0d820ec211414634303e"] | body | array |
| image_url | Default resolution image | https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_original.webp | body | string |
| downscaled_image_url | Medium resolution image | https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_avatar.webp | body | string |
| avatar_url | Lowest resolution image | https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_avatar.webp | body | string |
| order | Order of this custom theme | 3 | body | number |
| status | Status of the theme | body | string | |
| meta_data | Additional optional data | { "color": "#FF0000" } | body | object |
Response
(Note: Actual response can be different length and other fields may be present)
Delete a Custom Theme
Delete a custom theme you have previously created.
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| id | Unique identifier | 6256b0647d0bb100123effa7 | path | string |