API documentation

Refer to this documentation for a more comprehensive understanding of the API, and explore some examples in this repository for further insight.

Data

Get Categories

API for getting metric categories

get

/metric/categories

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/metric/categories'

200

401

200

No body

Successful Response

Download Metric Data

API for downloading metric data

get

/metric/{metric_id}/download

Authorizations

Path parameters

metric_idstringrequired

Metric Id

Query parameters

api_keystringrequired

API Key

symbolstring

Symbol, if the metric has no symbol, this parameter is not required

resolutionstring · default: 1h

Resolution, either 1h or 1d

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/metric/{metric_id}/download?api_key=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

422

200

No body

Successful Response

Download Latest Metric Data

API for downloading latest metric data

get

/metric/{metric_id}/download/latest

Authorizations

Path parameters

metric_idstringrequired

Metric Id

Query parameters

api_keystringrequired

API Key

symbolstring

Symbol, if the metric has no symbol, this parameter is not required

resolutionstring · default: 1h

Resolution, either 1h or 1d

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/metric/{metric_id}/download/latest?api_key=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

422

200

No body

Successful Response

Tournament

Get All Tournaments

API for getting all tournaments

get

/tournament/all

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/all'

200

401

200

[
  {
    "name": "text",
    "search_id": "text",
    "description": "text",
    "open_status": true
  }
]

Successful Response

Get current round of tournament

API for getting current round of tournament.

get

/tournament/{tournament_search_id}/current-round

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/{tournament_search_id}/current-round'

200

401

422

200

No body

Successful Response

Get symbols supported in tournament

API for getting symbols supported in tournament

get

/tournament/{tournament_search_id}/symbols

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/{tournament_search_id}/symbols'

200

401

422

200

No body

Successful Response

Get all submission types supported in tournament

API for getting submission types supported in tournament, this submission types are used to submit results to tournament

get

/tournament/{tournament_search_id}/submission-types

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/{tournament_search_id}/submission-types'

200

401

422

200

No body

Successful Response

Submit Results Via Api

Submit prediction results by API. If successful, return the submission time.

post

/tournament/{tournament_search_id}/submit/api

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Query parameters

api_keystringrequired

API Key

submission_typestringrequired

Submission type

symbolstringrequired

Symbol

model_idstringrequired

Model Id

Body

object[]

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/tournament/{tournament_search_id}/submit/api?api_key=text&submission_type=text&symbol=text&model_id=text' \
  --header 'Content-Type: application/json' \
  --data '[
    {}
  ]'

201

401

422

201

No body

Successful Response

Get All Submissions Time

API for getting all submissions time of user.

get

/tournament/{tournament_search_id}/submission-time/all

Authorizations

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Query parameters

api_keystringrequired

API Key

submission_typestring

Submission type

symbolstring

Symbol

model_idstring

Model Id

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/{tournament_search_id}/submission-time/all?api_key=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

422

200

No body

Successful Response

Get User Overall Performance

API for retrieving the overall user performance, where the performance metrics are specific to each round of the tournament.

get

/tournament/{tournament_search_id}/submission/overall-performance

Authorizations

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Query parameters

api_keystringrequired

API Key

submission_typestringrequired

Submission type

symbolstringrequired

Symbol

model_idstringrequired

Model Id

submission_timeinteger

Submission time

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/tournament/{tournament_search_id}/submission/overall-performance?api_key=text&submission_type=text&symbol=text&model_id=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

422

200

No body

Successful Response

Delete Submission

API for deleting submission record of user (used only for backtest mode)

delete

/tournament/{tournament_search_id}/submission

Authorizations

Path parameters

tournament_search_idstringrequired

Tournament Search Id

Query parameters

api_keystringrequired

API Key

submission_typestringrequired

Submission Type

symbolstringrequired

Symbol

model_idstringrequired

Model Id

submission_timeinteger

Submission time, if not provided, delete all submissions of the model

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/tournament/{tournament_search_id}/submission?api_key=text&submission_type=text&symbol=text&model_id=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

401

422

200

No body

Successful Response