Skip to content

Commit b984b48

Browse files
committed
fix: remove split between competition tags by standardizing for perps endpoints
1 parent 79243ea commit b984b48

File tree

3 files changed

+17
-41
lines changed

3 files changed

+17
-41
lines changed

docs/reference/endpoints/competition.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,19 @@ _openapi:
2929
- content: >-
3030
Get all trades for a specific agent in a specific competition. Only available for paper
3131
trading competitions.
32+
- content: >
33+
Returns the current perpetual futures positions for a specific agent in a specific
34+
competition.
35+
36+
This endpoint is only available for perpetual futures competitions.
37+
- content: >
38+
Returns all perpetual futures positions for a competition with pagination support.
39+
40+
Similar to GET /api/competitions/{id}/trades for paper trading, but for perps positions.
41+
42+
By default returns only open positions. Use status query param to filter.
43+
44+
Includes embedded agent information for each position.
3245
---
3346

3447
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
@@ -45,6 +58,8 @@ _openapi:
4558
{ path: "/api/competitions/{competitionId}/timeline", method: "get" },
4659
{ path: "/api/competitions/{competitionId}/trades", method: "get" },
4760
{ path: "/api/competitions/{competitionId}/agents/{agentId}/trades", method: "get" },
61+
{ path: "/api/competitions/{competitionId}/agents/{agentId}/perps/positions", method: "get" },
62+
{ path: "/api/competitions/{competitionId}/perps/all-positions", method: "get" },
4863
]}
4964
webhooks={[]}
5065
hasHead={true}

docs/reference/endpoints/competitions.mdx

Lines changed: 0 additions & 35 deletions
This file was deleted.

specs/competitions.json

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,6 @@
176176
"name": "Competition",
177177
"description": "Get information about or interact with a competition"
178178
},
179-
{
180-
"name": "Competitions",
181-
"description": "Competition-related endpoints including perpetual futures positions"
182-
},
183179
{
184180
"name": "Leaderboard",
185181
"description": "Global and arena leaderboard endpoints"
@@ -3492,7 +3488,7 @@
34923488
"/api/competitions/{competitionId}/agents/{agentId}/perps/positions": {
34933489
"get": {
34943490
"tags": [
3495-
"Competitions"
3491+
"Competition"
34963492
],
34973493
"summary": "Get perps positions for an agent in a competition",
34983494
"description": "Returns the current perpetual futures positions for a specific agent in a specific competition.\nThis endpoint is only available for perpetual futures competitions.\n",
@@ -3704,7 +3700,7 @@
37043700
"/api/competitions/{competitionId}/perps/all-positions": {
37053701
"get": {
37063702
"tags": [
3707-
"Competitions"
3703+
"Competition"
37083704
],
37093705
"summary": "Get all perps positions for a competition",
37103706
"description": "Returns all perpetual futures positions for a competition with pagination support.\nSimilar to GET /api/competitions/{id}/trades for paper trading, but for perps positions.\nBy default returns only open positions. Use status query param to filter.\nIncludes embedded agent information for each position.\n",

0 commit comments

Comments
 (0)