Skip to content

Commit

Permalink
update openapi file
Browse files Browse the repository at this point in the history
  • Loading branch information
Svisstack committed May 8, 2024
1 parent 8422377 commit b3601ae
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions data-api/coinapi-marketdata-rest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-04-29T10:40:19.1488249Z",
"time": "2024-05-08T12:39:57.8740226Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -711,7 +711,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-04-29T10:40:19.1488249Z",
"time": "2024-05-08T12:39:57.8740226Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -722,7 +722,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-04-29T10:40:19.1488249Z",
"time": "2024-05-08T12:39:57.8740226Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand All @@ -733,7 +733,7 @@ paths:
examples:
Example response:
value: {
"time": "2024-04-29T10:40:19.1488249Z",
"time": "2024-05-08T12:39:57.8740226Z",
"asset_id_base": "BTC",
"asset_id_quote": "USD",
"rate": 10000.0
Expand Down Expand Up @@ -7568,10 +7568,12 @@ tags:
description: "\n<span data-status-page=\"28929\"></span>\nThis section describes calls related to order book data, also known as books or passive level 2 data.\n\n:::info\nWhen requesting current data for a specific symbol, output is not encapsulated into JSON array as only one item is returned.\n:::\n\n:::info\nGET `/v1/orderbooks/current` endpoint is charged one request per 100 data points returned after applying a filter defined by filter_symbol_id parameter. If filter symbols target more than one exchange, error is returned.\n:::\n\n:::info\nWhen requesting current order book data limited to a single level, then quotes are actually used. This information is important from the perspective that quotes data could be faster than order book data (behavior is dependent solely one the data source) and they can have the size equal to 0 when the size is unknown. Some data sources publish order books and separately quote data (without the sizes) at a higher frequency. In that case, we will merge the order book feed with quotes feed to make sure that our updates are as fast as possible. The quotes will have the size equal to 0 as the value is unknown and the customer can decide if these higher frequency updates without the sizes are valuable or if not then can discard them or ask for at least 2 order book levels (in case of a REST API call). For the data sources that publish order books only or order books and quotes with the sizes then this will not happen.\n:::"
- name: Ohlcv
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: Assets
description: Controller for accessing asset information.
- name: Indexes
description: 'Indexes section of the API is in the Alpha release cycle. Use only for testing, evaluaton and feedback.'
- name: Assets
description: Controller for accessing asset information.
- name: Symbols
description: Controller for retrieving symbol information.
- 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: OrderBooks3
Expand All @@ -7580,8 +7582,6 @@ tags:
description: Controller for managing order book data.
- name: Quotes
description: 'Controller for retrieving quotes data, also known as quotes or passive level 1 data.'
- name: Symbols
description: Controller for retrieving symbol information.
- name: TimeSeries
description: 'Controller for retrieving OHLCV (Open, High, Low, Close, Volume) timeseries data.'
- name: Trades
Expand Down

0 comments on commit b3601ae

Please sign in to comment.