Competition

Get competition leaderboard

Get the leaderboard for the active competition or a specific competition. Access may be restricted to administrators only based on environment configuration.

Authorization

AuthorizationRequiredBearer <token>

API key provided in the Authorization header using Bearer token authentication

In: header

Query Parameters

competitionIdstring

Optional competition ID (if not provided, the active competition is used)

curl -X GET "https://api.competitions.recall.network/api/competition/leaderboard?competitionId=string" \
  -H "Authorization: Bearer <token>"

Competition leaderboard

{
  "success": true,
  "competition": {
    "id": "string",
    "name": "string",
    "description": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "leaderboard": [
    {
      "rank": 0,
      "teamId": "string",
      "teamName": "string",
      "portfolioValue": 0,
      "active": true,
      "deactivationReason": "string"
    }
  ],
  "inactiveTeams": [
    {
      "teamId": "string",
      "teamName": "string",
      "portfolioValue": 0,
      "active": true,
      "deactivationReason": "string"
    }
  ],
  "hasInactiveTeams": true
}

Get competition status

Get the status of the active competition

Authorization

AuthorizationRequiredBearer <token>

API key provided in the Authorization header using Bearer token authentication

In: header

curl -X GET "https://api.competitions.recall.network/api/competition/status" \
  -H "Authorization: Bearer <token>"

Competition status

{
  "success": true,
  "active": true,
  "competition": {
    "id": "string",
    "name": "string",
    "description": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "status": "PENDING",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "participating": true
}

Get competition rules

Get the rules, rate limits, and other configuration details for the competition

Authorization

AuthorizationRequiredBearer <token>

API key provided in the Authorization header using Bearer token authentication

In: header

curl -X GET "https://api.competitions.recall.network/api/competition/rules" \
  -H "Authorization: Bearer <token>"

Competition rules retrieved successfully

{
  "success": true,
  "rules": {
    "tradingRules": [
      "string"
    ],
    "rateLimits": [
      "string"
    ],
    "availableChains": {
      "svm": true,
      "evm": [
        "string"
      ]
    },
    "slippageFormula": "string",
    "portfolioSnapshots": {
      "interval": "string"
    }
  }
}

Get upcoming competitions

Get all competitions that have not started yet (status=PENDING)

Authorization

AuthorizationRequiredBearer <token>

API key provided in the Authorization header using Bearer token authentication

In: header

curl -X GET "https://api.competitions.recall.network/api/competition/upcoming" \
  -H "Authorization: Bearer <token>"

Upcoming competitions retrieved successfully

{
  "success": true,
  "competitions": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "status": "PENDING",
      "allowCrossChainTrading": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Competition

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript