Skip to content

Commit c5b7ebc

Browse files
committed
update openapi file
1 parent d635f5c commit c5b7ebc

File tree

2 files changed

+24
-22
lines changed

2 files changed

+24
-22
lines changed

coinapi/market-data-api-rest/spec/openapi.json

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,7 +1062,7 @@
10621062
"examples": {
10631063
"Example response": {
10641064
"value": {
1065-
"time": "2025-07-28T06:04:13.8108943Z",
1065+
"time": "2025-07-28T11:24:40.6020808Z",
10661066
"asset_id_base": "BTC",
10671067
"asset_id_quote": "USD",
10681068
"rate": 10000.0
@@ -1077,7 +1077,7 @@
10771077
"examples": {
10781078
"Example response": {
10791079
"value": {
1080-
"time": "2025-07-28T06:04:13.8108943Z",
1080+
"time": "2025-07-28T11:24:40.6020808Z",
10811081
"asset_id_base": "BTC",
10821082
"asset_id_quote": "USD",
10831083
"rate": 10000.0
@@ -1092,7 +1092,7 @@
10921092
"examples": {
10931093
"Example response": {
10941094
"value": {
1095-
"time": "2025-07-28T06:04:13.8108943Z",
1095+
"time": "2025-07-28T11:24:40.6020808Z",
10961096
"asset_id_base": "BTC",
10971097
"asset_id_quote": "USD",
10981098
"rate": 10000.0
@@ -1107,7 +1107,7 @@
11071107
"examples": {
11081108
"Example response": {
11091109
"value": {
1110-
"time": "2025-07-28T06:04:13.8108943Z",
1110+
"time": "2025-07-28T11:24:40.6020808Z",
11111111
"asset_id_base": "BTC",
11121112
"asset_id_quote": "USD",
11131113
"rate": 10000.0
@@ -7561,8 +7561,8 @@
75617561
"tags": [
75627562
"Metadata"
75637563
],
7564-
"summary": "List all symbols",
7565-
"description": "Retrieves all symbols with optional filtering.\n \n:::info\n\"price_precision\" and \"size_precision\" are data precisions and are not always the same precisions used for trading eg. for the \"BINANCE\" exchanges.\n:::\n \n:::info\nYou should not assume that the market data will be always within the resolution provided by the \"price_precision\" and \"size_precision\". The fact that the precision values can be derived from a posterior implies the fact that this data could be delayed, also it can be changed by the data source without notice and we will immediately deliver data with the new precision while could not update the precision values in this endpoint immediately.\n:::\n \n### Symbol identifier\n \nOur symbol identifier is created using a pattern that depends on symbol type.\n \nType | `symbol_id` pattern\n--------- | ---------\nSPOT | `{exchange_id}_SPOT_{asset_id_base}_{asset_id_quote}`\nFUTURES | `{exchange_id}_FTS_{asset_id_base}_{asset_id_quote}_{YYMMDD of future_delivery_time}`\nOPTION | `{exchange_id}_OPT_{asset_id_base}_{asset_id_quote}_{YYMMDD of option_expiration_time}_{option_strike_price}_{option_type_is_call as C/P}`\nPERPETUAL | `{exchange_id}_PERP_{asset_id_base}_{asset_id_quote}`\nINDEX | `{exchange_id}_IDX_{index_id}`\nCREDIT | `{exchange_id}_CRE_{asset_id_base}`\nCONTACT | `{exchange_id}_COT_{contract_id}`\n \n:::info\nIn the unlikely event when the \"symbol_id\" for more than one market is the same. We will append the additional term (prefixed with the \"_\") at the end of the duplicated identifiers to differentiate them.\n:::info\n \n### Symbol types list (enumeration of `symbol_type` output variable)\n \nType | Name | Description\n-------- | - | -----------\nSPOT | FX Spot | Agreement to exchange one asset for another one *(e.g. Buy BTC for USD)*\nFUTURES | Futures contract | FX Spot derivative contract where traders agree to trade fx spot at predetermined future time\nOPTION | Option contract | FX Spot derivative contract where traders agree to trade right to require buy or sell of fx spot at agreed price on exercise date\nPERPETUAL | Perpetual contract | FX Spot derivative contract where traders agree to trade fx spot continously without predetermined future delivery time\nINDEX | Index | Statistical composite that measures changes in the economy or markets.\nCREDIT | Credit/Funding | Margin funding contract. Order book displays lending offers and borrow bids. Price represents the daily rate.\nCONTRACT | Contract | Represents other types of financial instruments *(e.g. spreads, interest rate swap)*\n \n### Additional output variables for `symbol_type = INDEX`\n \nVariable | Description\n--------- | -----------\nindex_id | Index identifier\nindex_display_name | Human readable name of the index *(optional)*\nindex_display_description | Description of the index *(optional)*\n \n### Additional output variables for `symbol_type = FUTURES`\n \nVariable | Description\n--------- | -----------\nfuture_delivery_time | Predetermined time of futures contract delivery date in ISO 8601\nfuture_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)*\nfuture_contract_unit_asset | Identifier of the asset used to denominate the contract unit\n \n### Additional output variables for `symbol_type = PERPETUAL`\n \nVariable | Description\n--------- | -----------\nfuture_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)*\nfuture_contract_unit_asset | Identifier of the asset used to denominate the contract unit\n \n### Additional output variables for `symbol_type = OPTION`\n \nVariable | Description\n--------- | -----------\noption_type_is_call | Boolean value representing option type. `true` for Call options, `false` for Put options\noption_strike_price | Price at which option contract can be exercised\noption_contract_unit | Base asset amount of underlying spot which single option represents\noption_exercise_style | Option exercise style. Can be `EUROPEAN` or `AMERICAN`\noption_expiration_time | Option contract expiration time in ISO 8601\n \n### Additional output variables for `symbol_type = CONTRACT`\n \nVariable | Description\n--------- | -----------\ncontract_delivery_time | Predetermined time of contract delivery date in ISO 8601\ncontract_unit | Contact size *(eg. 10 BTC if `contract_unit` = `10` and `contract_unit_asset` = `BTC`)*\ncontract_unit_asset | Identifier of the asset used to denominate the contract unit\ncontract_id | Identifier of contract by the exchange",
7564+
"summary": "List all active symbols",
7565+
"description": "Retrieves all currently active (listed) symbols, with optional filtering.\n \n:::info\n\"price_precision\" and \"size_precision\" are data precisions and are not always the same precisions used for trading eg. for the \"BINANCE\" exchanges.\n:::\n \n:::info\nYou should not assume that the market data will be always within the resolution provided by the \"price_precision\" and \"size_precision\". The fact that the precision values can be derived from a posterior implies the fact that this data could be delayed, also it can be changed by the data source without notice and we will immediately deliver data with the new precision while could not update the precision values in this endpoint immediately.\n:::\n \n### Symbol identifier\n \nOur symbol identifier is created using a pattern that depends on symbol type.\n \nType | `symbol_id` pattern\n--------- | ---------\nSPOT | `{exchange_id}_SPOT_{asset_id_base}_{asset_id_quote}`\nFUTURES | `{exchange_id}_FTS_{asset_id_base}_{asset_id_quote}_{YYMMDD of future_delivery_time}`\nOPTION | `{exchange_id}_OPT_{asset_id_base}_{asset_id_quote}_{YYMMDD of option_expiration_time}_{option_strike_price}_{option_type_is_call as C/P}`\nPERPETUAL | `{exchange_id}_PERP_{asset_id_base}_{asset_id_quote}`\nINDEX | `{exchange_id}_IDX_{index_id}`\nCREDIT | `{exchange_id}_CRE_{asset_id_base}`\nCONTACT | `{exchange_id}_COT_{contract_id}`\n \n:::info\nIn the unlikely event when the \"symbol_id\" for more than one market is the same. We will append the additional term (prefixed with the \"_\") at the end of the duplicated identifiers to differentiate them.\n:::info\n \n### Symbol types list (enumeration of `symbol_type` output variable)\n \nType | Name | Description\n-------- | - | -----------\nSPOT | FX Spot | Agreement to exchange one asset for another one *(e.g. Buy BTC for USD)*\nFUTURES | Futures contract | FX Spot derivative contract where traders agree to trade fx spot at predetermined future time\nOPTION | Option contract | FX Spot derivative contract where traders agree to trade right to require buy or sell of fx spot at agreed price on exercise date\nPERPETUAL | Perpetual contract | FX Spot derivative contract where traders agree to trade fx spot continously without predetermined future delivery time\nINDEX | Index | Statistical composite that measures changes in the economy or markets.\nCREDIT | Credit/Funding | Margin funding contract. Order book displays lending offers and borrow bids. Price represents the daily rate.\nCONTRACT | Contract | Represents other types of financial instruments *(e.g. spreads, interest rate swap)*\n \n### Additional output variables for `symbol_type = INDEX`\n \nVariable | Description\n--------- | -----------\nindex_id | Index identifier\nindex_display_name | Human readable name of the index *(optional)*\nindex_display_description | Description of the index *(optional)*\n \n### Additional output variables for `symbol_type = FUTURES`\n \nVariable | Description\n--------- | -----------\nfuture_delivery_time | Predetermined time of futures contract delivery date in ISO 8601\nfuture_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)*\nfuture_contract_unit_asset | Identifier of the asset used to denominate the contract unit\n \n### Additional output variables for `symbol_type = PERPETUAL`\n \nVariable | Description\n--------- | -----------\nfuture_contract_unit | Contact size *(eg. 10 BTC if `future_contract_unit` = `10` and `future_contract_unit_asset` = `BTC`)*\nfuture_contract_unit_asset | Identifier of the asset used to denominate the contract unit\n \n### Additional output variables for `symbol_type = OPTION`\n \nVariable | Description\n--------- | -----------\noption_type_is_call | Boolean value representing option type. `true` for Call options, `false` for Put options\noption_strike_price | Price at which option contract can be exercised\noption_contract_unit | Base asset amount of underlying spot which single option represents\noption_exercise_style | Option exercise style. Can be `EUROPEAN` or `AMERICAN`\noption_expiration_time | Option contract expiration time in ISO 8601\n \n### Additional output variables for `symbol_type = CONTRACT`\n \nVariable | Description\n--------- | -----------\ncontract_delivery_time | Predetermined time of contract delivery date in ISO 8601\ncontract_unit | Contact size *(eg. 10 BTC if `contract_unit` = `10` and `contract_unit_asset` = `BTC`)*\ncontract_unit_asset | Identifier of the asset used to denominate the contract unit\ncontract_id | Identifier of contract by the exchange",
75667566
"parameters": [
75677567
{
75687568
"name": "filter_symbol_id",
@@ -7883,7 +7883,7 @@
78837883
"tags": [
78847884
"Metadata"
78857885
],
7886-
"summary": "List symbol mapping for the exchange",
7886+
"summary": "List active symbol mapping for the exchange",
78877887
"parameters": [
78887888
{
78897889
"name": "exchange_id",
@@ -7941,7 +7941,7 @@
79417941
"tags": [
79427942
"Metadata"
79437943
],
7944-
"summary": "List of symbols for the exchange",
7944+
"summary": "List of active symbols for the exchange",
79457945
"parameters": [
79467946
{
79477947
"name": "exchange_id",
@@ -8263,7 +8263,8 @@
82638263
"tags": [
82648264
"Metadata"
82658265
],
8266-
"summary": "Get symbol history for an exchange with pagination.",
8266+
"summary": "List all historical symbols for an exchange.",
8267+
"description": "This endpoint provides access to symbols that are no longer actively traded or listed on a given exchange.\nThe data is provided with pagination support.",
82678268
"parameters": [
82688269
{
82698270
"name": "exchange_id",
@@ -8277,7 +8278,7 @@
82778278
{
82788279
"name": "page",
82798280
"in": "query",
8280-
"description": "The page number.",
8281+
"description": "The page number for pagination (starts from 1).",
82818282
"schema": {
82828283
"type": "integer",
82838284
"format": "int32",
@@ -8287,7 +8288,7 @@
82878288
{
82888289
"name": "limit",
82898290
"in": "query",
8290-
"description": "Number of records to return.",
8291+
"description": "Number of records to return per page.",
82918292
"schema": {
82928293
"type": "integer",
82938294
"format": "int32",

0 commit comments

Comments
 (0)