Skip to content

Commit eeed4bd

Browse files
SvisstackSvisstack
committed
update openapi file
1 parent 18cd68e commit eeed4bd

2 files changed

Lines changed: 72 additions & 8 deletions

File tree

‎finfeedapi/prediction-markets-api-rest/spec/openapi.json‎

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -337,10 +337,12 @@
337337
"Market Activity"
338338
],
339339
"summary": "Returns recent trades and recent quotes for a market.",
340+
"description": "Trades and quotes are returned as separate lists. The `limit` applies independently to each list\n(default 100, max 10000 per list).",
340341
"parameters": [
341342
{
342343
"name": "exchange_id",
343344
"in": "path",
345+
"description": "The unique identifier of the exchange.",
344346
"required": true,
345347
"schema": {
346348
"type": "string"
@@ -349,10 +351,21 @@
349351
{
350352
"name": "market_id",
351353
"in": "path",
354+
"description": "The unique identifier of the market, including the outcome suffix.",
352355
"required": true,
353356
"schema": {
354357
"type": "string"
355358
}
359+
},
360+
{
361+
"name": "limit",
362+
"in": "query",
363+
"description": "Maximum number of trades and quotes to return in each list (1-10000, default 100)",
364+
"schema": {
365+
"type": "integer",
366+
"format": "int32",
367+
"default": 100
368+
}
356369
}
357370
],
358371
"responses": {
@@ -393,7 +406,7 @@
393406
"Market Activity"
394407
],
395408
"summary": "Returns historical trades for a market from flat files.",
396-
"description": "Retrieves historical trade data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each trade also includes time_exchange showing\nwhen the trade actually occurred on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
409+
"description": "Retrieves historical trade data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each trade also includes time_exchange showing\nwhen the trade actually occurred on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
397410
"parameters": [
398411
{
399412
"name": "exchange_id",
@@ -414,27 +427,31 @@
414427
{
415428
"name": "date",
416429
"in": "query",
430+
"description": "Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)",
417431
"schema": {
418432
"type": "string"
419433
}
420434
},
421435
{
422436
"name": "time_start",
423437
"in": "query",
438+
"description": "Range start in ISO 8601 (required if date is omitted)",
424439
"schema": {
425440
"type": "string"
426441
}
427442
},
428443
{
429444
"name": "time_end",
430445
"in": "query",
446+
"description": "Range end in ISO 8601 (optional)",
431447
"schema": {
432448
"type": "string"
433449
}
434450
},
435451
{
436452
"name": "limit",
437453
"in": "query",
454+
"description": "Maximum number of trades to return (1-10000, default 100). Applies even when date selects a full day.",
438455
"schema": {
439456
"type": "integer",
440457
"format": "int32",
@@ -489,7 +506,7 @@
489506
"Market Activity"
490507
],
491508
"summary": "Returns historical quotes for a market from flat files.",
492-
"description": "Retrieves historical quote (bid/ask) data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each quote also includes time_exchange showing\nwhen the quote was created on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
509+
"description": "Retrieves historical quote (bid/ask) data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each quote also includes time_exchange showing\nwhen the quote was created on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
493510
"parameters": [
494511
{
495512
"name": "exchange_id",
@@ -510,27 +527,31 @@
510527
{
511528
"name": "date",
512529
"in": "query",
530+
"description": "Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)",
513531
"schema": {
514532
"type": "string"
515533
}
516534
},
517535
{
518536
"name": "time_start",
519537
"in": "query",
538+
"description": "Range start in ISO 8601 (required if date is omitted)",
520539
"schema": {
521540
"type": "string"
522541
}
523542
},
524543
{
525544
"name": "time_end",
526545
"in": "query",
546+
"description": "Range end in ISO 8601 (optional)",
527547
"schema": {
528548
"type": "string"
529549
}
530550
},
531551
{
532552
"name": "limit",
533553
"in": "query",
554+
"description": "Maximum number of quotes to return (1-10000, default 100). Applies even when date selects a full day.",
534555
"schema": {
535556
"type": "integer",
536557
"format": "int32",
@@ -1202,7 +1223,7 @@
12021223
"OHLCV"
12031224
],
12041225
"summary": "Historical data for an exchange",
1205-
"description": "Get OHLCV timeseries data for an exchange, returned in time ascending order.",
1226+
"description": "Get OHLCV timeseries data for an exchange, returned in time ascending order.\nTime range is limited to 24 hours. Use `limit` to cap the number of market rows returned.",
12061227
"parameters": [
12071228
{
12081229
"name": "exchange_id",
@@ -1237,6 +1258,16 @@
12371258
"schema": {
12381259
"type": "string"
12391260
}
1261+
},
1262+
{
1263+
"name": "limit",
1264+
"in": "query",
1265+
"description": "Maximum number of market rows to return (1-10000, default 100)",
1266+
"schema": {
1267+
"type": "integer",
1268+
"format": "int32",
1269+
"default": 100
1270+
}
12401271
}
12411272
],
12421273
"responses": {
@@ -1582,7 +1613,7 @@
15821613
"Orderbooks"
15831614
],
15841615
"summary": "Returns historical orderbook limit orders for a market from flat files.",
1585-
"description": "Retrieves historical limit order data from flat files stored in external storage (S3).\nReturns raw limit order updates (adds, updates, deletes) rather than reconstructed snapshots.\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each order also includes time_exchange showing\nwhen the order was created/updated on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
1616+
"description": "Retrieves historical limit order data from flat files stored in external storage (S3).\nReturns raw limit order updates (adds, updates, deletes) rather than reconstructed snapshots.\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each order also includes time_exchange showing\nwhen the order was created/updated on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi.",
15861617
"parameters": [
15871618
{
15881619
"name": "exchange_id",
@@ -1603,27 +1634,31 @@
16031634
{
16041635
"name": "date",
16051636
"in": "query",
1637+
"description": "Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)",
16061638
"schema": {
16071639
"type": "string"
16081640
}
16091641
},
16101642
{
16111643
"name": "time_start",
16121644
"in": "query",
1645+
"description": "Range start in ISO 8601 (required if date is omitted)",
16131646
"schema": {
16141647
"type": "string"
16151648
}
16161649
},
16171650
{
16181651
"name": "time_end",
16191652
"in": "query",
1653+
"description": "Range end in ISO 8601 (optional)",
16201654
"schema": {
16211655
"type": "string"
16221656
}
16231657
},
16241658
{
16251659
"name": "limit",
16261660
"in": "query",
1661+
"description": "Maximum number of limit order updates to return (1-10000, default 100). Applies even when date selects a full day.",
16271662
"schema": {
16281663
"type": "integer",
16291664
"format": "int32",

‎finfeedapi/prediction-markets-api-rest/spec/openapi.yaml‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -254,17 +254,27 @@ paths:
254254
tags:
255255
- Market Activity
256256
summary: Returns recent trades and recent quotes for a market.
257+
description: "Trades and quotes are returned as separate lists. The `limit` applies independently to each list\n(default 100, max 10000 per list)."
257258
parameters:
258259
- name: exchange_id
259260
in: path
261+
description: The unique identifier of the exchange.
260262
required: true
261263
schema:
262264
type: string
263265
- name: market_id
264266
in: path
267+
description: 'The unique identifier of the market, including the outcome suffix.'
265268
required: true
266269
schema:
267270
type: string
271+
- name: limit
272+
in: query
273+
description: 'Maximum number of trades and quotes to return in each list (1-10000, default 100)'
274+
schema:
275+
type: integer
276+
format: int32
277+
default: 100
268278
responses:
269279
'200':
270280
description: Recent trades and quotes (lists may be empty).
@@ -288,7 +298,7 @@ paths:
288298
tags:
289299
- Market Activity
290300
summary: Returns historical trades for a market from flat files.
291-
description: "Retrieves historical trade data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each trade also includes time_exchange showing\nwhen the trade actually occurred on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
301+
description: "Retrieves historical trade data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each trade also includes time_exchange showing\nwhen the trade actually occurred on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
292302
parameters:
293303
- name: exchange_id
294304
in: path
@@ -302,18 +312,22 @@ paths:
302312
type: string
303313
- name: date
304314
in: query
315+
description: Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)
305316
schema:
306317
type: string
307318
- name: time_start
308319
in: query
320+
description: Range start in ISO 8601 (required if date is omitted)
309321
schema:
310322
type: string
311323
- name: time_end
312324
in: query
325+
description: Range end in ISO 8601 (optional)
313326
schema:
314327
type: string
315328
- name: limit
316329
in: query
330+
description: 'Maximum number of trades to return (1-10000, default 100). Applies even when date selects a full day.'
317331
schema:
318332
type: integer
319333
format: int32
@@ -347,7 +361,7 @@ paths:
347361
tags:
348362
- Market Activity
349363
summary: Returns historical quotes for a market from flat files.
350-
description: "Retrieves historical quote (bid/ask) data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each quote also includes time_exchange showing\nwhen the quote was created on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
364+
description: "Retrieves historical quote (bid/ask) data from flat files stored in external storage (S3).\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each quote also includes time_exchange showing\nwhen the quote was created on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
351365
parameters:
352366
- name: exchange_id
353367
in: path
@@ -361,18 +375,22 @@ paths:
361375
type: string
362376
- name: date
363377
in: query
378+
description: Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)
364379
schema:
365380
type: string
366381
- name: time_start
367382
in: query
383+
description: Range start in ISO 8601 (required if date is omitted)
368384
schema:
369385
type: string
370386
- name: time_end
371387
in: query
388+
description: Range end in ISO 8601 (optional)
372389
schema:
373390
type: string
374391
- name: limit
375392
in: query
393+
description: 'Maximum number of quotes to return (1-10000, default 100). Applies even when date selects a full day.'
376394
schema:
377395
type: integer
378396
format: int32
@@ -895,7 +913,7 @@ paths:
895913
tags:
896914
- OHLCV
897915
summary: Historical data for an exchange
898-
description: 'Get OHLCV timeseries data for an exchange, returned in time ascending order.'
916+
description: "Get OHLCV timeseries data for an exchange, returned in time ascending order.\nTime range is limited to 24 hours. Use `limit` to cap the number of market rows returned."
899917
parameters:
900918
- name: exchange_id
901919
in: path
@@ -919,6 +937,13 @@ paths:
919937
description: Timeseries ending time in ISO 8601
920938
schema:
921939
type: string
940+
- name: limit
941+
in: query
942+
description: 'Maximum number of market rows to return (1-10000, default 100)'
943+
schema:
944+
type: integer
945+
format: int32
946+
default: 100
922947
responses:
923948
'200':
924949
description: successful operation
@@ -1146,7 +1171,7 @@ paths:
11461171
tags:
11471172
- Orderbooks
11481173
summary: Returns historical orderbook limit orders for a market from flat files.
1149-
description: "Retrieves historical limit order data from flat files stored in external storage (S3).\nReturns raw limit order updates (adds, updates, deletes) rather than reconstructed snapshots.\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each order also includes time_exchange showing\nwhen the order was created/updated on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
1174+
description: "Retrieves historical limit order data from flat files stored in external storage (S3).\nReturns raw limit order updates (adds, updates, deletes) rather than reconstructed snapshots.\nSupports hourly granularity with automatic fallback to daily files.\nUse either 'date' for full day or 'time_start'/'time_end' for specific time ranges.\nThe `limit` parameter applies in both cases (default 100, max 10000), including when `date` selects a full day.\n \n**Important:** Results are filtered by data processing time (time_coinapi) - the time when CoinAPI\nreceived and processed the data from the exchange. Each order also includes time_exchange showing\nwhen the order was created/updated on the exchange. Due to API polling delays, time_exchange may be\nearlier than time_coinapi."
11501175
parameters:
11511176
- name: exchange_id
11521177
in: path
@@ -1160,18 +1185,22 @@ paths:
11601185
type: string
11611186
- name: date
11621187
in: query
1188+
description: Full day in ISO 8601 or YYYY-MM-DD (mutually exclusive with time_start/time_end)
11631189
schema:
11641190
type: string
11651191
- name: time_start
11661192
in: query
1193+
description: Range start in ISO 8601 (required if date is omitted)
11671194
schema:
11681195
type: string
11691196
- name: time_end
11701197
in: query
1198+
description: Range end in ISO 8601 (optional)
11711199
schema:
11721200
type: string
11731201
- name: limit
11741202
in: query
1203+
description: 'Maximum number of limit order updates to return (1-10000, default 100). Applies even when date selects a full day.'
11751204
schema:
11761205
type: integer
11771206
format: int32

0 commit comments

Comments
 (0)