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)
"root":[
0:{
"id":
string"6256b0647d0bb100123effa7"
"title":
string"İhracat Şampiyonları"
"description":
string"En çok ihracat yapan şirketler."
"region":[
0
:
string"tr"
"assetClass":
string"equity"
"imageUrl":
string"https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_original.webp"
"avatarUrl":
string""
"numStocks":
int15
"order":
int0
"status":
string"active"
1:{
"id":
string"64ff31e14ee6ea1024a76e73"
"title":
string"Halka Arzlar"
"description":
string"En son halka arz olan ÅŸirketler."
"region":[
0
:
string"tr"
"assetClass":
string"equity"
"imageUrl":
string"https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/yeni-halka-arzlar.webp"
"avatarUrl":
string""
"numStocks":
int20
"order":
int1
"status":
string"active"
2:{
"id":
string"6256b37b53c18400117a8598"
"title":
string"Temettü Aristokratları"
"description":
string"Temettü verimi sürekli yüksek olan şirketler"
"region":[
0
:
string"tr"
"assetClass":
string"equity"
"imageUrl":
string"https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/temettu-padisahlari_original.webp"
"avatarUrl":
string""
"numStocks":
int12
"order":
int2
"status":
string"inactive"
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)
"root":{
"id":
string"6256b0647d0bb100123effa7"
"title":
string"İhracat Şampiyonları"
"region":[
0
:
string"tr"
"description":
string"En çok ihracat yapan şirketler."
"assetClass":
string"equity"
"imageUrl":
string"https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_original.webp"
"avatarUrl":
string"https://finfree-storage.s3.eu-central-1.amazonaws.com/collection-images/ihracat-sampiyonlari_avatar.webp"
"numStocks":
int15
"order":
int1
"status":
string"active"
"stocks":[
0:{
"id":
string"61dd0d4b0ec2114146342f69"
"assetType":
string"stock"
"name":
string"Şişe ve Cam Fabrikaları"
"symbol":
string"SISE"
"sectorId":
string"65533e047844ee7afe9941be"
"industryId":
string"65533e441fa5c7b58afa0956"
"dailyChange":
float0.0214126
1:{
"id":
string"61dd0d820ec211414634303e"
"assetType":
string"stock"
"name":
string"Vestel Elektronik"
"symbol":
string"VESTL"
"sectorId":
string"65533e047844ee7afe9941b9"
"industryId":
string"65533e441fa5c7b58afa0939"
"dailyChange":
float0.0193186
"locale":
string"tr"
"meta_data":{
"color":
string"#FF0000"
Create New Custom Theme
Create a new custom theme with the specified data.
Endpoint
https://api.finfree.app/api/v1/custom-theme?api_key=demo
POST
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)
"root":{
"id":
string"660c339fd7924abc17507c20"
Delete a Custom Theme
Delete a custom theme you have previously created.
Endpoint
https://api.finfree.app/api/v1/custom-theme//6256b0647d0bb100123effa7?api_key=demo
DELETE
Parameters
| Name | Description | Example | Parameter Type | Data Type |
|---|---|---|---|---|
| id | Unique identifier | 6256b0647d0bb100123effa7 | path | string |