Public Contest

Public endpoints for contest information

Join a contest

post

Allows the authenticated user to join a contest. Creates a contest account, deposits the initial balance, and registers the participant.

Path parameters

contestIdinteger · int64Required

Contest ID

Example: 1

Body

application/json

Request body for joining a contest

nicknamestring · max: 255Optional

Nickname to display on the leaderboard

Example: TradingPro123

Responses

200

Successfully joined contest

*/*

Complete contest account information with current state and historical snapshots

idinteger · int64Optional

Contest account info ID

Example: 1

contestIdinteger · int64Optional

Contest ID

Example: 1

accountIdinteger · int64Optional

Account ID

Example: 123

fundedAccountIdinteger · int64Optional

Funded account ID

Example: 200

userIdinteger · int32Optional

User ID

Example: 50

demoContestAccountIdinteger · int64Optional

Demo contest account ID

Example: 300

initialBalancenumberOptional

Initial balance for the contest account

Example: 10000

joinTimestring · date-timeOptional

Join time in ISO format

nicknamestringOptional

Participant's nickname or display name

Example: TradingPro123

contestStatusstringOptional

Contest participation status

Example: IN_PROGRESS

disqualificationReasonstringOptional

Reason for disqualification

Example: Exceeded maximum drawdown limit

currentRankinteger · int32Optional

Current rank in contest

Example: 3

currentNetPerformancenumberOptional

Current net performance percentage

Example: 25.5

currentEquitynumberOptional

Current equity

Example: 12500

currentBalancenumberOptional

Current balance

Example: 12000

totalTradesCountinteger · int32Optional

Total number of trades

Example: 25

tradingDaysCountinteger · int32Optional

Number of active trading days

Example: 10

currentMaxDrawdownnumberOptional

Current maximum drawdown percentage

Example: 8.5

currentMaxDayDrawdownnumberOptional

Current maximum daily drawdown percentage

Example: 4.2

lastSnapshotTimestring · date-timeOptional

Latest snapshot time in ISO format

profitRatioViolatedbooleanOptional

Indicates if the profit ratio rule was violated

Example: false

400

Invalid request - contest ended, disabled, deadline passed, nickname taken, or already registered

401

Unauthorized - authentication required

500

Internal server error

post

/v1/contest/{contestId}/join

HTTPcURLJavaScriptPython

POST /api/v1/contest/{contestId}/join HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "nickname": "TradingPro123"
}

{
  "id": 1,
  "contestId": 1,
  "accountId": 123,
  "fundedAccountId": 200,
  "userId": 50,
  "demoContestAccountId": 300,
  "initialBalance": 10000,
  "joinTime": "2026-06-08T15:46:52.860Z",
  "nickname": "TradingPro123",
  "contestStatus": "IN_PROGRESS",
  "disqualificationReason": "Exceeded maximum drawdown limit",
  "currentRank": 3,
  "currentNetPerformance": 25.5,
  "currentEquity": 12500,
  "currentBalance": 12000,
  "totalTradesCount": 25,
  "tradingDaysCount": 10,
  "currentMaxDrawdown": 8.5,
  "currentMaxDayDrawdown": 4.2,
  "lastSnapshotTime": "2026-06-08T15:46:52.860Z",
  "profitRatioViolated": false,
  "snapshotHistory": [
    {
      "snapshotTime": "2026-06-08T15:46:52.860Z",
      "equity": 12500,
      "balance": 12000,
      "netPerformance": 25.5,
      "maxDrawdown": 8.5,
      "maxDayDrawdown": 4.2,
      "totalTradesCount": 25,
      "tradingDaysCount": 10,
      "rank": 3
    }
  ]
}

Get all contests categorized by status

get

Retrieves all non-deleted contests categorized into active, upcoming, and ended lists. Includes participant count and top return for each contest.

Responses

200

Successfully retrieved contests

*/*

DTO representing categorized lists of contests for an account.

500

Internal server error

get

/v1/contest

HTTPcURLJavaScriptPython

GET /api/v1/contest HTTP/1.1
Accept: */*

{
  "active": [
    {
      "id": 1,
      "status": "text",
      "pricePool": "text",
      "name": "text",
      "currency": "text",
      "startTime": "2026-06-08T15:46:52.860Z",
      "endTime": "2026-06-08T15:46:52.860Z",
      "lastJoinTime": "2026-06-08T15:46:52.860Z",
      "topReturn": "text",
      "participants": 1,
      "enabled": true,
      "initialDeposit": 1,
      "prizeDistributionBuckets": [
        1
      ],
      "minTotalTrades": 1,
      "minActiveTradingDays": 1,
      "minNetPerformancePercent": 1,
      "maxTotalDrawdownPercent": 1,
      "maxDailyDrawdownPercent": 1,
      "maxSingleTradePnlPercent": 1,
      "profitRatioRuleEnabled": true,
      "minPremiumPercentPerTrade": 1,
      "minTradeHoldMinutes": 1,
      "minExpiryHoldPercent": 1,
      "minExpiryHours": 1
    }
  ],
  "upcomming": [
    {
      "id": 1,
      "status": "text",
      "pricePool": "text",
      "name": "text",
      "currency": "text",
      "startTime": "2026-06-08T15:46:52.860Z",
      "endTime": "2026-06-08T15:46:52.860Z",
      "lastJoinTime": "2026-06-08T15:46:52.860Z",
      "topReturn": "text",
      "participants": 1,
      "enabled": true,
      "initialDeposit": 1,
      "prizeDistributionBuckets": [
        1
      ],
      "minTotalTrades": 1,
      "minActiveTradingDays": 1,
      "minNetPerformancePercent": 1,
      "maxTotalDrawdownPercent": 1,
      "maxDailyDrawdownPercent": 1,
      "maxSingleTradePnlPercent": 1,
      "profitRatioRuleEnabled": true,
      "minPremiumPercentPerTrade": 1,
      "minTradeHoldMinutes": 1,
      "minExpiryHoldPercent": 1,
      "minExpiryHours": 1
    }
  ],
  "ended": [
    {
      "id": 1,
      "status": "text",
      "pricePool": "text",
      "name": "text",
      "currency": "text",
      "startTime": "2026-06-08T15:46:52.860Z",
      "endTime": "2026-06-08T15:46:52.860Z",
      "lastJoinTime": "2026-06-08T15:46:52.860Z",
      "topReturn": "text",
      "participants": 1,
      "enabled": true,
      "initialDeposit": 1,
      "prizeDistributionBuckets": [
        1
      ],
      "minTotalTrades": 1,
      "minActiveTradingDays": 1,
      "minNetPerformancePercent": 1,
      "maxTotalDrawdownPercent": 1,
      "maxDailyDrawdownPercent": 1,
      "maxSingleTradePnlPercent": 1,
      "profitRatioRuleEnabled": true,
      "minPremiumPercentPerTrade": 1,
      "minTradeHoldMinutes": 1,
      "minExpiryHoldPercent": 1,
      "minExpiryHours": 1
    }
  ]
}

Get contest by ID

get

Retrieves detailed information about a specific contest by its ID, including all metadata and statistics.

Path parameters

idinteger · int64Required

Responses

200

Successfully retrieved contest

*/*

DTO containing information about a contest.

idinteger · int64Optional

Unique identifier of the contest

statusstringOptional

Current status of the contest (e.g., active, ended, upcoming)

pricePoolstringOptional

Prize pool for the contest

namestringOptional

Name of the contest

currencystringOptional

Currency used in the contest

startTimestring · date-timeOptional

Start time of the contest in ISO format

endTimestring · date-timeOptional

End time of the contest in ISO format

lastJoinTimestring · date-timeOptional

Last allowed join time in ISO format

topReturnstringOptional

Top return achieved in the contest

participantsinteger · int32Optional

Number of participants in the contest

enabledbooleanOptional

Whether the contest is enabled

initialDepositnumberOptional

Initial deposit amount for participants

prizeDistributionBucketsnumber[]Optional

Prize distribution buckets (prize amounts)

minTotalTradesinteger · int32Optional

Minimum number of total trades required

minActiveTradingDaysinteger · int32Optional

Minimum number of active trading days required

minNetPerformancePercentnumberOptional

Minimum net performance percentage required

maxTotalDrawdownPercentnumberOptional

Maximum allowed total drawdown percentage

maxDailyDrawdownPercentnumberOptional

Maximum allowed daily drawdown percentage

maxSingleTradePnlPercentnumberOptional

Maximum allowed single trade PnL percentage

profitRatioRuleEnabledbooleanOptional

Whether profit ratio rule is enabled

minPremiumPercentPerTradenumberOptional

Minimum premium percentage per trade

minTradeHoldMinutesinteger · int32Optional

Minimum time to hold a trade in minutes

minExpiryHoldPercentnumberOptional

Minimum expiry hold percentage

minExpiryHoursinteger · int32Optional

Minimum number of hours until expiry

404

Contest not found

500

Internal server error

get

/v1/contest/{id}

HTTPcURLJavaScriptPython

GET /api/v1/contest/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "status": "text",
  "pricePool": "text",
  "name": "text",
  "currency": "text",
  "startTime": "2026-06-08T15:46:52.860Z",
  "endTime": "2026-06-08T15:46:52.860Z",
  "lastJoinTime": "2026-06-08T15:46:52.860Z",
  "topReturn": "text",
  "participants": 1,
  "enabled": true,
  "initialDeposit": 1,
  "prizeDistributionBuckets": [
    1
  ],
  "minTotalTrades": 1,
  "minActiveTradingDays": 1,
  "minNetPerformancePercent": 1,
  "maxTotalDrawdownPercent": 1,
  "maxDailyDrawdownPercent": 1,
  "maxSingleTradePnlPercent": 1,
  "profitRatioRuleEnabled": true,
  "minPremiumPercentPerTrade": 1,
  "minTradeHoldMinutes": 1,
  "minExpiryHoldPercent": 1,
  "minExpiryHours": 1
}

Get contest leaderboard

get

Retrieves the leaderboard for a specific contest with participant rankings and performance data. Supports pagination with optional page and size parameters.

Path parameters

contestIdinteger · int64Required

Contest ID

Example: 1

Query parameters

pageinteger · int32Optional

Page number (0-indexed)

Default: 0Example: 0

sizeinteger · int32Optional

Page size (number of entries per page)

Default: 100Example: 100

Responses

200

Successfully retrieved leaderboard

*/*

Contest leaderboard entry with participant performance data

idinteger · int64Optional

Contest account info ID

Example: 1

rankinteger · int32Optional

Current rank in the contest

Example: 1

nicknamestringOptional

Participant's nickname or display name

Example: TradingPro123

netPerformancenumberOptional

Net performance percentage

Example: 25.5

totalTradesCountinteger · int32Optional

Total number of trades

Example: 25

tradingDaysCountinteger · int32Optional

Number of active trading days

Example: 10

maxDrawdownnumberOptional

Maximum drawdown percentage

Example: 8.5

maxDayDrawdownnumberOptional

Maximum daily drawdown percentage

Example: 4.2

joinTimestring · date-timeOptional

Join time in ISO format

contestStatusstringOptional

Contest participation status

Example: IN_PROGRESS,NOT_QUALIFIED,COMPLETED

404

Contest not found

500

Internal server error

get

/v1/contest/{contestId}/leaderboard

HTTPcURLJavaScriptPython

GET /api/v1/contest/{contestId}/leaderboard HTTP/1.1
Accept: */*

{
  "id": 1,
  "rank": 1,
  "nickname": "TradingPro123",
  "netPerformance": 25.5,
  "totalTradesCount": 25,
  "tradingDaysCount": 10,
  "maxDrawdown": 8.5,
  "maxDayDrawdown": 4.2,
  "joinTime": "2026-06-08T15:46:52.860Z",
  "contestStatus": "IN_PROGRESS,NOT_QUALIFIED,COMPLETED"
}

Get contest account information for authenticated user

get

Retrieves the authenticated user's contest account information including current performance, latest snapshot data, and historical snapshots for charting (up to 30 most recent snapshots).

Path parameters

contestIdinteger · int64Required

Contest ID

Example: 1

Responses

200

Successfully retrieved contest account information

*/*

Complete contest account information with current state and historical snapshots

idinteger · int64Optional

Contest account info ID

Example: 1

contestIdinteger · int64Optional

Contest ID

Example: 1

accountIdinteger · int64Optional

Account ID

Example: 123

fundedAccountIdinteger · int64Optional

Funded account ID

Example: 200

userIdinteger · int32Optional

User ID

Example: 50

demoContestAccountIdinteger · int64Optional

Demo contest account ID

Example: 300

initialBalancenumberOptional

Initial balance for the contest account

Example: 10000

joinTimestring · date-timeOptional

Join time in ISO format

nicknamestringOptional

Participant's nickname or display name

Example: TradingPro123

contestStatusstringOptional

Contest participation status

Example: IN_PROGRESS

disqualificationReasonstringOptional

Reason for disqualification

Example: Exceeded maximum drawdown limit

currentRankinteger · int32Optional

Current rank in contest

Example: 3

currentNetPerformancenumberOptional

Current net performance percentage

Example: 25.5

currentEquitynumberOptional

Current equity

Example: 12500

currentBalancenumberOptional

Current balance

Example: 12000

totalTradesCountinteger · int32Optional

Total number of trades

Example: 25

tradingDaysCountinteger · int32Optional

Number of active trading days

Example: 10

currentMaxDrawdownnumberOptional

Current maximum drawdown percentage

Example: 8.5

currentMaxDayDrawdownnumberOptional

Current maximum daily drawdown percentage

Example: 4.2

lastSnapshotTimestring · date-timeOptional

Latest snapshot time in ISO format

profitRatioViolatedbooleanOptional

Indicates if the profit ratio rule was violated

Example: false

401

Unauthorized - authentication required

404

Contest or account not found

500

Internal server error

get

/v1/contest/{contestId}/account-info

HTTPcURLJavaScriptPython

GET /api/v1/contest/{contestId}/account-info HTTP/1.1
Accept: */*

{
  "id": 1,
  "contestId": 1,
  "accountId": 123,
  "fundedAccountId": 200,
  "userId": 50,
  "demoContestAccountId": 300,
  "initialBalance": 10000,
  "joinTime": "2026-06-08T15:46:52.860Z",
  "nickname": "TradingPro123",
  "contestStatus": "IN_PROGRESS",
  "disqualificationReason": "Exceeded maximum drawdown limit",
  "currentRank": 3,
  "currentNetPerformance": 25.5,
  "currentEquity": 12500,
  "currentBalance": 12000,
  "totalTradesCount": 25,
  "tradingDaysCount": 10,
  "currentMaxDrawdown": 8.5,
  "currentMaxDayDrawdown": 4.2,
  "lastSnapshotTime": "2026-06-08T15:46:52.860Z",
  "profitRatioViolated": false,
  "snapshotHistory": [
    {
      "snapshotTime": "2026-06-08T15:46:52.860Z",
      "equity": 12500,
      "balance": 12000,
      "netPerformance": 25.5,
      "maxDrawdown": 8.5,
      "maxDayDrawdown": 4.2,
      "totalTradesCount": 25,
      "tradingDaysCount": 10,
      "rank": 3
    }
  ]
}