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 Dec 3, 2024
1 parent 37b390b commit 2c518bb
Showing 1 changed file with 4 additions and 236 deletions.
240 changes: 4 additions & 236 deletions data-api/coinapi-marketdata-rest.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-11-27T10:03:44.5325107Z",
"time": "2024-12-03T10:03:48.4863077Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -704,7 +704,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-11-27T10:03:44.5325107Z",
"time": "2024-12-03T10:03:48.4863077Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -715,7 +715,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-11-27T10:03:44.5325107Z",
"time": "2024-12-03T10:03:48.4863077Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -726,7 +726,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-11-27T10:03:44.5325107Z",
"time": "2024-12-03T10:03:48.4863077Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand Down Expand Up @@ -1688,147 +1688,6 @@ paths:
"url": "https://s3.eu-central-1.amazonaws.com/bbxt-static-icons/type-id/png_16/b7c77041cdef4f359b4044b2d73c7741.png"
}
]
/v1/indexes:
get:
tags:
- Indexes
summary: List indexes
responses:
'200':
description: successful operation
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/v1.Index'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.Index'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.Index'
application/x-msgpack:
schema:
type: array
items:
$ref: '#/components/schemas/v1.Index'
'/v1/indexes/{index_id}/history':
get:
tags:
- Indexes
summary: Historical Index Value w/Composition
parameters:
- name: index_id
in: path
required: true
schema:
type: string
- name: time_start
in: query
schema:
type: string
format: date-time
- name: time_end
in: query
schema:
type: string
format: date-time
- name: limit
in: query
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: successful operation
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexValue'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexValue'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexValue'
application/x-msgpack:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexValue'
'/v1/indexes/{index_id}/timeseries':
get:
tags:
- Indexes
summary: Timeseries Index Value
parameters:
- name: index_id
in: path
description: ''
required: true
schema:
type: string
- name: period_id
in: query
description: Identifier of requested timeseries period (e.g. `5SEC` or `1DAY`)
required: true
schema:
type: string
- name: time_start
in: query
description: Timeseries starting time in ISO 8601
required: true
schema:
type: string
- name: time_end
in: query
description: Timeseries ending time in ISO 8601
required: true
schema:
type: string
- name: limit
in: query
description: 'Amount of items to return (optional, mininum is 1, maximum is 100000, default value is 100, if the parameter is used then every 100 output items are counted as one request)'
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: successful operation
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexTimeseriesItem'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexTimeseriesItem'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexTimeseriesItem'
application/x-msgpack:
schema:
type: array
items:
$ref: '#/components/schemas/v1.IndexTimeseriesItem'
/v1/metrics/listing:
get:
tags:
Expand Down Expand Up @@ -7107,95 +6966,6 @@ components:
nullable: true
additionalProperties: false
description: Represents an icon.
v1.Index:
type: object
properties:
index_id:
type: string
description: Gets or sets the index ID associated with the index.
nullable: true
name:
type: string
description: Gets or sets the name associated with the index.
nullable: true
description:
type: string
description: Gets or sets the descripion of the index.
nullable: true
additionalProperties: false
description: Represents an index.
v1.IndexTimeseriesItem:
type: object
properties:
time_period_start:
type: string
description: The start time of the time period.
format: date-time
time_period_end:
type: string
description: The end time of the time period.
format: date-time
time_open:
type: string
description: The time when the value opened.
format: date-time
nullable: true
time_close:
type: string
description: The time when the value closed.
format: date-time
nullable: true
value_open:
type: number
description: The opening value.
format: double
nullable: true
value_high:
type: number
description: The highest value during the time period.
format: double
nullable: true
value_low:
type: number
description: The lowest value during the time period.
format: double
nullable: true
value_close:
type: number
description: The closing value.
format: double
nullable: true
value_count:
type: integer
description: The number of values during the time period.
format: int64
additionalProperties: false
description: Represents a timeseries item with value information.
v1.IndexValue:
type: object
properties:
timestamp:
type: string
format: date-time
value:
type: number
format: double
composition:
type: array
items:
$ref: '#/components/schemas/v1.IndexValueComponent'
nullable: true
additionalProperties: false
v1.IndexValueComponent:
type: object
properties:
component_id:
type: string
nullable: true
component_value:
type: number
format: double
additionalProperties: false
v1.LastTrade:
type: object
properties:
Expand Down Expand Up @@ -7841,8 +7611,6 @@ tags:
description: "\n<span data-status-page=\"28926\"></span>\n\nAPI calls described in this section are related to downloading OHLCV *(Open, High, Low, Close, Volume)* timeseries data.\nEach data point of this timeseries represents several indicators calculated from transactions activity inside a time range (period).\n\n:::info\nOHLCV data primary purpose is to present an overview of the market in human readable form. \nIt's often used to visualize market data on charts, websites, and various kinds of reports.\n:::\n\n:::tip\nCoinAPI expanded the standard OHLCV timeseries by including time of first and last trade and amount of trades executed inside period.\n:::\n "
- name: Metadata
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: Metrics
description: "<span data-status-page=\"28933\"></span>\r\nMetrics are quantitative measurements used to evaluate the performance and activity of cryptocurrency exchanges. These metrics include:\r\n\r\n1. Trading Volume: The total amount of cryptocurrency traded on an exchange within a specific time period, indicating liquidity and activity.\r\n1. Market Depth: The level of buy and sell orders at different price levels, providing insights into liquidity and potential price impact.\r\n1. Order Book: A record of outstanding buy and sell orders for a cryptocurrency, reflecting supply and demand dynamics.\r\n1. Spread: The difference between the highest bid and lowest ask prices, indicating liquidity and trading costs.\r\n1. Price Charts: Visual representations of cryptocurrency price movements over time, helping identify trends and inform trading decisions.\r\n1. Market Cap: The total value of a cryptocurrency calculated by its price multiplied by circulating supply, reflecting relative size and value.\r\n1. Trading Pairs: Combinations of cryptocurrencies available for trading, including volume, price, and spread for each pair.\r\n1. User Metrics: Data on active users, new registrations, user retention, and engagement, indicating platform popularity and growth.\r\n1. Trading Fees: Fees charged for executing trades, including fee structure, discounts, and revenue generated by the exchange.\r\n1. Security Metrics: Measures assessing the security of an exchange, such as past incidents, user fund protection, and security audits.\r\n\r\nThese metrics assist traders and investors in evaluating market activity, liquidity, and the reliability of crypto exchanges for informed decision-making."
- name: Options
Expand Down

0 comments on commit 2c518bb

Please sign in to comment.