Skip to content

Commit

Permalink
update openapi file
Browse files Browse the repository at this point in the history
  • Loading branch information
@Svisstack
Svisstack committed Nov 26, 2024
1 parent 547e387 commit ad1ee2a
Showing 1 changed file with 58 additions and 178 deletions.
236 changes: 58 additions & 178 deletions indexes-api/coinapi-indexes-rest.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,26 +40,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
application/json:
Expand All @@ -73,26 +59,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
text/json:
Expand All @@ -106,26 +78,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
application/x-msgpack:
Expand All @@ -139,26 +97,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
'/api/metadata/exchanges/{exchange_id}':
Expand Down Expand Up @@ -188,26 +132,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
application/json:
Expand All @@ -221,26 +151,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
text/json:
Expand All @@ -254,26 +170,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
application/x-msgpack:
Expand All @@ -287,26 +189,12 @@ paths:
{
"exchange_id": "OKCOIN_CNY",
"website": "https://www.okcoin.cn/",
"name": "OKCoin CNY",
"data_quote_start": "2015-02-15T12:53:50.343+00:00",
"data_quote_end": "2018-03-09T23:34:52.58+00:00",
"data_orderbook_start": "2015-02-15T12:53:50.343+00:00",
"data_orderbook_end": "2018-03-09T23:34:52.58+00:00",
"data_trade_start": "2013-06-12T14:24:24+00:00",
"data_trade_end": "2017-11-01T16:30:39.7077259+00:00",
"data_symbols_count": 2
"name": "OKCoin CNY"
},
{
"exchange_id": "HUOBI",
"website": "https://www.huobi.com/",
"name": "Huobi (HBUS)",
"data_quote_start": "2015-03-29T21:46:06.263+00:00",
"data_quote_end": "2019-11-03T18:22:29.1837496+00:00",
"data_orderbook_start": "2015-03-29T21:46:06.263+00:00",
"data_orderbook_end": "2019-11-03T18:23:53.2859878+00:00",
"data_trade_start": "2015-03-29T21:46:08.703+00:00",
"data_trade_end": "2019-11-03T18:21:48.277+00:00",
"data_symbols_count": 403
"name": "Huobi (HBUS)"
}
]
/v1/indexes:
Expand Down Expand Up @@ -836,6 +724,46 @@ paths:
"value_count": 0
}
]
'/v1/indexdef/input-data/{index_definition_id}':
get:
tags:
- Indexes
summary: Returns data inputs for certain index definition and time
parameters:
- name: index_definition_id
in: path
required: true
schema:
type: string
- name: time
in: query
schema:
type: string
format: date-time
responses:
'200':
description: successful operation
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Indexes.IndexDefinitionSnapshotEntry'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Indexes.IndexDefinitionSnapshotEntry'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Indexes.IndexDefinitionSnapshotEntry'
application/x-msgpack:
schema:
type: array
items:
$ref: '#/components/schemas/Indexes.IndexDefinitionSnapshotEntry'
/v1/metadata/periods:
get:
tags:
Expand Down Expand Up @@ -1089,56 +1017,6 @@ components:
type: string
description: Gets or sets the name of the exchange.
nullable: true
data_start:
type: string
description: Gets the start date of the exchange's data.
nullable: true
readOnly: true
data_end:
type: string
description: Gets the end date of the exchange's data.
nullable: true
readOnly: true
data_quote_start:
type: string
description: Gets or sets the start date of quote data.
format: date-time
nullable: true
data_quote_end:
type: string
description: Gets or sets the end date of quote data.
format: date-time
nullable: true
data_orderbook_start:
type: string
description: Gets or sets the start date of order book data.
format: date-time
nullable: true
data_orderbook_end:
type: string
description: Gets or sets the end date of order book data.
format: date-time
nullable: true
data_trade_start:
type: string
description: Gets or sets the start date of trade data.
format: date-time
nullable: true
data_trade_end:
type: string
description: Gets or sets the end date of trade data.
format: date-time
nullable: true
data_trade_count:
type: integer
description: Gets or sets the number of trades.
format: int64
nullable: true
data_symbols_count:
type: integer
description: Gets or sets the number of symbols.
format: int64
nullable: true
additionalProperties: false
description: Represents an exchange.
Metadata.TimeseriesPeriod:
Expand Down Expand Up @@ -1186,5 +1064,7 @@ tags:
description: <span data-status-page="28923"></span>
- name: Indexes
description: 'Indexes section of the API is in the Alpha release cycle. Use only for testing, evaluaton and feedback.'
- name: InputData
description: 'Indexes section of the API is in the Alpha release cycle. Use only for testing, evaluaton and feedback.'
- name: Period
description: Controller for periods.

0 comments on commit ad1ee2a

Please sign in to comment.