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
API for downloading metric data
Metric Id
API Key
Symbol, if the metric has no symbol, this parameter is not required
Resolution, either 1h or 1d
1hSuccessful Response
No content
Unauthorized
Validation Error
GET /metric/{metric_id}/download?api_key=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
API for downloading latest metric data
Metric Id
API Key
Symbol, if the metric has no symbol, this parameter is not required
Resolution, either 1h or 1d
1hSuccessful Response
No content
Unauthorized
Validation Error
GET /metric/{metric_id}/download/latest?api_key=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Tournament
API for getting current round of tournament.
Tournament Search Id
Successful Response
Unauthorized
Validation Error
GET /tournament/{tournament_search_id}/current-round HTTP/1.1
Host:
Accept: */*
No content
API for getting symbols supported in tournament
Tournament Search Id
Successful Response
Unauthorized
Validation Error
GET /tournament/{tournament_search_id}/symbols HTTP/1.1
Host:
Accept: */*
No content
API for getting submission types supported in tournament, this submission types are used to submit results to tournament
Tournament Search Id
Successful Response
Unauthorized
Validation Error
GET /tournament/{tournament_search_id}/submission-types HTTP/1.1
Host:
Accept: */*
No content
Submit prediction results by API. If successful, return the submission time.
Tournament Search Id
API Key
Submission type
Symbol
Model Id
Successful Response
Unauthorized
Validation Error
POST /tournament/{tournament_search_id}/submit/api?api_key=text&submission_type=text&symbol=text&model_id=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 4
[
{}
]No content
API for getting all submissions time of user.
Tournament Search Id
API Key
Submission type
Symbol
Model Id
Successful Response
Unauthorized
Validation Error
GET /tournament/{tournament_search_id}/submission-time/all?api_key=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
API for retrieving the overall user performance, where the performance metrics are specific to each round of the tournament.
Tournament Search Id
API Key
Submission type
Symbol
Model Id
Submission time
Successful Response
Unauthorized
Validation Error
GET /tournament/{tournament_search_id}/submission/overall-performance?api_key=text&submission_type=text&symbol=text&model_id=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
API for deleting submission record of user (used only for backtest mode)
Tournament Search Id
API Key
Submission Type
Symbol
Model Id
Submission time, if not provided, delete all submissions of the model
Successful Response
Unauthorized
Validation Error
DELETE /tournament/{tournament_search_id}/submission?api_key=text&submission_type=text&symbol=text&model_id=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated