Skip to content

Commit 1ed299d

Browse files
committed
update openapi file
1 parent 444e4cb commit 1ed299d

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

finfeedapi/currencies-api-rest-historical/spec/openapi.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"openapi": "3.0.1",
2+
"openapi": "3.0.4",
33
"info": {
44
"title": "FX Historical REST API",
55
"contact": {
@@ -25,7 +25,7 @@
2525
"Metadata"
2626
],
2727
"summary": "List all assets",
28-
"description": "Retrieves all assets.\r\n \r\n:::info\r\nOur asset identifiers are aligned with the ISO 4217 currency codes standard only for fiat money (government or law regulated currency).\r\n:::\r\n \r\n:::info\r\nProperties of the output are providing aggregated information from across all symbols related to the specific asset. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\r\n:::",
28+
"description": "Retrieves all assets.\n \n:::info\nOur asset identifiers are aligned with the ISO 4217 currency codes standard only for fiat money (government or law regulated currency).\n:::\n \n:::info\nProperties of the output are providing aggregated information from across all symbols related to the specific asset. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\n:::",
2929
"parameters": [
3030
{
3131
"name": "filter_asset_id",
@@ -597,7 +597,7 @@
597597
"Exchange Rates"
598598
],
599599
"summary": "Get specific rate",
600-
"description": "Retrieves the exchange rate for a specific base and quote asset at a given time or the current rate.\r\n \r\n:::info\r\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\r\n:::",
600+
"description": "Retrieves the exchange rate for a specific base and quote asset at a given time or the current rate.\n \n:::info\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\n:::",
601601
"operationId": "Get specific rate",
602602
"parameters": [
603603
{
@@ -638,7 +638,7 @@
638638
"examples": {
639639
"Example response": {
640640
"value": {
641-
"time": "2025-06-10T06:13:33.5931919Z",
641+
"time": "2025-06-10T12:41:34.1245040Z",
642642
"asset_id_base": "BTC",
643643
"asset_id_quote": "USD",
644644
"rate": 10000.0
@@ -653,7 +653,7 @@
653653
"examples": {
654654
"Example response": {
655655
"value": {
656-
"time": "2025-06-10T06:13:33.5931919Z",
656+
"time": "2025-06-10T12:41:34.1245040Z",
657657
"asset_id_base": "BTC",
658658
"asset_id_quote": "USD",
659659
"rate": 10000.0
@@ -668,7 +668,7 @@
668668
"examples": {
669669
"Example response": {
670670
"value": {
671-
"time": "2025-06-10T06:13:33.5931919Z",
671+
"time": "2025-06-10T12:41:34.1245040Z",
672672
"asset_id_base": "BTC",
673673
"asset_id_quote": "USD",
674674
"rate": 10000.0
@@ -687,7 +687,7 @@
687687
"Exchange Rates"
688688
],
689689
"summary": "Get all current rates",
690-
"description": "Get the current exchange rate between requested asset and all other assets.\r\n \r\n:::info\r\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\r\n:::\r\n \r\n:::info\r\nYou can invert the rates by using Y = 1 / X equation, for example BTC/USD = 1 / (USD/BTC);\r\n:::",
690+
"description": "Get the current exchange rate between requested asset and all other assets.\n \n:::info\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\n:::\n \n:::info\nYou can invert the rates by using Y = 1 / X equation, for example BTC/USD = 1 / (USD/BTC);\n:::",
691691
"parameters": [
692692
{
693693
"name": "asset_id_base",
@@ -841,7 +841,7 @@
841841
"Exchange Rates"
842842
],
843843
"summary": "Timeseries periods",
844-
"description": "You can also obtain historical exchange rates of any asset pair, grouped into time periods.\r\nGet full list of supported time periods available for requesting exchange rates historical timeseries data.\r\n \r\n## Timeseries periods\r\nTime unit |\tPeriod identifiers\r\n--- | ---\r\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\r\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\r\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\r\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY",
844+
"description": "You can also obtain historical exchange rates of any asset pair, grouped into time periods.\nGet full list of supported time periods available for requesting exchange rates historical timeseries data.\n \n## Timeseries periods\nTime unit |\tPeriod identifiers\n--- | ---\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY",
845845
"responses": {
846846
"200": {
847847
"description": "successful operation",

finfeedapi/currencies-api-rest-historical/spec/openapi.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
openapi: 3.0.1
1+
openapi: 3.0.4
22
info:
33
title: FX Historical REST API
44
contact:
@@ -17,7 +17,7 @@ paths:
1717
tags:
1818
- Metadata
1919
summary: List all assets
20-
description: "Retrieves all assets.\r\n \r\n:::info\r\nOur asset identifiers are aligned with the ISO 4217 currency codes standard only for fiat money (government or law regulated currency).\r\n:::\r\n \r\n:::info\r\nProperties of the output are providing aggregated information from across all symbols related to the specific asset. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\r\n:::"
20+
description: "Retrieves all assets.\n \n:::info\nOur asset identifiers are aligned with the ISO 4217 currency codes standard only for fiat money (government or law regulated currency).\n:::\n \n:::info\nProperties of the output are providing aggregated information from across all symbols related to the specific asset. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\n:::"
2121
parameters:
2222
- name: filter_asset_id
2323
in: query
@@ -514,7 +514,7 @@ paths:
514514
tags:
515515
- Exchange Rates
516516
summary: Get specific rate
517-
description: "Retrieves the exchange rate for a specific base and quote asset at a given time or the current rate.\r\n \r\n:::info\r\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\r\n:::"
517+
description: "Retrieves the exchange rate for a specific base and quote asset at a given time or the current rate.\n \n:::info\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\n:::"
518518
operationId: Get specific rate
519519
parameters:
520520
- name: asset_id_base
@@ -544,7 +544,7 @@ paths:
544544
examples:
545545
Example response:
546546
value: {
547-
"time": "2025-06-10T06:13:33.7007159Z",
547+
"time": "2025-06-10T12:41:34.2769443Z",
548548
"asset_id_base": "BTC",
549549
"asset_id_quote": "USD",
550550
"rate": 10000.0
@@ -555,7 +555,7 @@ paths:
555555
examples:
556556
Example response:
557557
value: {
558-
"time": "2025-06-10T06:13:33.7007159Z",
558+
"time": "2025-06-10T12:41:34.2769443Z",
559559
"asset_id_base": "BTC",
560560
"asset_id_quote": "USD",
561561
"rate": 10000.0
@@ -566,7 +566,7 @@ paths:
566566
examples:
567567
Example response:
568568
value: {
569-
"time": "2025-06-10T06:13:33.7007159Z",
569+
"time": "2025-06-10T12:41:34.2769443Z",
570570
"asset_id_base": "BTC",
571571
"asset_id_quote": "USD",
572572
"rate": 10000.0
@@ -576,7 +576,7 @@ paths:
576576
tags:
577577
- Exchange Rates
578578
summary: Get all current rates
579-
description: "Get the current exchange rate between requested asset and all other assets.\r\n \r\n:::info\r\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\r\n:::\r\n \r\n:::info\r\nYou can invert the rates by using Y = 1 / X equation, for example BTC/USD = 1 / (USD/BTC);\r\n:::"
579+
description: "Get the current exchange rate between requested asset and all other assets.\n \n:::info\nIf you are using an exchange rate for mission-critical operations, then for best reliability, you should measure the difference between current time and the time returned from the response to ensure that value of the difference between those meets your internal requirements.\n:::\n \n:::info\nYou can invert the rates by using Y = 1 / X equation, for example BTC/USD = 1 / (USD/BTC);\n:::"
580580
parameters:
581581
- name: asset_id_base
582582
in: path
@@ -699,7 +699,7 @@ paths:
699699
tags:
700700
- Exchange Rates
701701
summary: Timeseries periods
702-
description: "You can also obtain historical exchange rates of any asset pair, grouped into time periods.\r\nGet full list of supported time periods available for requesting exchange rates historical timeseries data.\r\n \r\n## Timeseries periods\r\nTime unit |\tPeriod identifiers\r\n--- | ---\r\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\r\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\r\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\r\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY"
702+
description: "You can also obtain historical exchange rates of any asset pair, grouped into time periods.\nGet full list of supported time periods available for requesting exchange rates historical timeseries data.\n \n## Timeseries periods\nTime unit |\tPeriod identifiers\n--- | ---\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY"
703703
responses:
704704
'200':
705705
description: successful operation

0 commit comments

Comments
 (0)