Skip to content

Commit d3fb92a

Browse files
feat: update bitgo-api-docs
This commit updates the BitGo API.
1 parent c584cb2 commit d3fb92a

File tree

1 file changed

+53
-12
lines changed

1 file changed

+53
-12
lines changed

api.yaml

Lines changed: 53 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8993,17 +8993,22 @@ paths:
89938993
tags:
89948994
- Market Data
89958995
summary: Get historical prices
8996-
description: Get a list of historical prices in a specified time range. Using this endpoint requires an access token with the appropriate enterprise ID.
8996+
description: |
8997+
Get a list of historical OHLCV (Open, High, Low, Close, Volume) prices for a currency pair within a specified time range.
8998+
Using this endpoint requires an access token with the appropriate enterprise ID.
89978999
operationId: marketdata.cryptocompare.historical.prices.get
89989000
parameters:
89999001
- $ref: '#/components/parameters/Base'
90009002
- $ref: '#/components/parameters/Quote'
90019003
- $ref: '#/components/parameters/Interval'
90029004
- $ref: '#/components/parameters/Start'
90039005
- $ref: '#/components/parameters/End'
9006+
- $ref: '#/components/parameters/NextBatchPrevId'
90049007
responses:
90059008
'200':
9006-
description: Returns historical-price data points. Also returns a page cursor if there are more than 1,000 results.
9009+
description: |
9010+
Returns historical-price data points.
9011+
Also returns a page cursor if there are more than 1,000 results.
90079012
content:
90089013
application/json:
90099014
schema:
@@ -9021,7 +9026,9 @@ paths:
90219026
tags:
90229027
- Market Data
90239028
summary: Get spot prices
9024-
description: Get historical spot prices from a specific time. Using this endpoint requires an access token with the appropriate enterprise ID.
9029+
description: |
9030+
Get historical spot prices from a specific time.
9031+
Using this endpoint requires an access token with the appropriate enterprise ID.
90259032
operationId: marketdata.cryptocompare.spot.prices.get
90269033
parameters:
90279034
- $ref: '#/components/parameters/Base'
@@ -42149,8 +42156,10 @@ components:
4214942156
name: base
4215042157
in: query
4215142158
required: true
42152-
description: The asset or currency to compare to the quote asset or currency (case insensitive).
42153-
example: btc
42159+
description: |
42160+
The base currency symbol (the asset being priced).
42161+
Must be a BitGo-supported instrument symbol (case-insensitive).
42162+
example: BTC
4215442163
schema:
4215542164
type: string
4215642165
CreatedDateGte1:
@@ -42175,7 +42184,9 @@ components:
4217542184
name: end
4217642185
in: query
4217742186
required: false
42178-
description: End time for the pricing data range. If not provided, defaults to the current time.
42187+
description: |
42188+
End time for the pricing data range (RFC 3339 format).
42189+
If not provided, defaults to the current time.
4217942190
schema:
4218042191
type: string
4218142192
format: date-time
@@ -42255,7 +42266,7 @@ components:
4225542266
name: interval
4225642267
in: query
4225742268
required: true
42258-
description: Unit of time.
42269+
description: The time interval for each price data point.
4225942270
example: hour
4226042271
schema:
4226142272
type: string
@@ -42272,6 +42283,16 @@ components:
4227242283
schema:
4227342284
type: integer
4227442285
example: 20
42286+
NextBatchPrevId:
42287+
name: nextBatchPrevId
42288+
in: query
42289+
required: false
42290+
description: |
42291+
Pagination cursor returned from a previous request.
42292+
Use this to fetch the next batch of results when there are more than 1,000 data points.
42293+
schema:
42294+
type: string
42295+
example: 63ff9f4c0c01fcd7162c28fc901ad915
4227542296
PolicyRuleId:
4227642297
name: id
4227742298
in: path
@@ -42329,8 +42350,10 @@ components:
4232942350
name: quote
4233042351
in: query
4233142352
required: true
42332-
description: The asset or currency to compare to the base asset or currency (case insensitive).
42333-
example: eth
42353+
description: |
42354+
The quote currency symbol (the currency in which the price is expressed).
42355+
Must be a BitGo-supported instrument symbol (case-insensitive).
42356+
example: USD
4233442357
schema:
4233542358
type: string
4233642359
ScopeName1:
@@ -42350,7 +42373,9 @@ components:
4235042373
name: start
4235142374
in: query
4235242375
required: false
42353-
description: Start time for the pricing data range. If not provided, defaults to 1 interval before to the current time.
42376+
description: |
42377+
Start time for the pricing data range (RFC 3339 format).
42378+
If not provided, defaults to 1 interval before the current time.
4235442379
schema:
4235542380
type: string
4235642381
format: date-time
@@ -57423,6 +57448,7 @@ components:
5742357448
- trustedTokens
5742457449
HistoricalPrice:
5742557450
type: object
57451+
description: OHLCV price data for a single time interval.
5742657452
required:
5742757453
- time
5742857454
- open
@@ -57435,24 +57461,31 @@ components:
5743557461
time:
5743657462
type: string
5743757463
format: date-time
57464+
description: The timestamp marking the start of this interval (RFC 3339 format).
5743857465
open:
5743957466
type: number
5744057467
format: float
57468+
description: The opening price at the start of the interval.
5744157469
high:
5744257470
type: number
5744357471
format: float
57472+
description: The highest price reached during the interval.
5744457473
low:
5744557474
type: number
5744657475
format: float
57476+
description: The lowest price reached during the interval.
5744757477
close:
5744857478
type: number
5744957479
format: float
57480+
description: The closing price at the end of the interval.
5745057481
base_volume:
5745157482
type: number
5745257483
format: float
57484+
description: The total trading volume in the base currency during the interval.
5745357485
quote_volume:
5745457486
type: number
5745557487
format: float
57488+
description: The total trading volume in the quote currency during the interval.
5745657489
example:
5745757490
time: '2014-11-07T22:19:28.578Z'
5745857491
open: 576.0590066
@@ -57463,23 +57496,29 @@ components:
5746357496
quote_volume: 170627.62385
5746457497
HistoricalPriceResult:
5746557498
type: object
57499+
description: Response containing historical price data with pagination support.
5746657500
required:
5746757501
- data
5746857502
properties:
5746957503
data:
5747057504
type: object
5747157505
required:
5747257506
- prices
57473-
- nextBatchPrevId
5747457507
properties:
5747557508
prices:
5747657509
type: object
57510+
description: A map of currency pair to price data
57511+
example: BTC-USD
5747757512
additionalProperties:
5747857513
type: array
5747957514
items:
5748057515
$ref: '#/components/schemas/HistoricalPrice'
5748157516
nextBatchPrevId:
5748257517
type: string
57518+
nullable: true
57519+
description: |
57520+
Pagination cursor for fetching the next batch of results.
57521+
Null if there are no more results.
5748357522
example:
5748457523
data:
5748557524
prices:
@@ -60349,12 +60388,14 @@ components:
6034960388
latestFutureTransferDate: 2025-12-02T10:00:00.000Z
6035060389
MarketDataError:
6035160390
type: object
60352-
description: Market Data Error
60391+
description: Error response for market data requests.
6035360392
properties:
6035460393
error:
6035560394
type: string
60395+
description: Detailed error message.
6035660396
errorName:
6035760397
type: string
60398+
description: Error code identifier.
6035860399
required:
6035960400
- error
6036060401
- errorName

0 commit comments

Comments
 (0)