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

Response

200401

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/metric/categories', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Download Metric Data

API for downloading metric data

GET/metric/{metric_id}/download

Authorization

HTTPBearer

Path parameters

metric_id*Metric Id

Metric Id

Query parameters

Response

200401422

Successful Response

Request

JavaScriptCurlPython

const response = await fetch('/metric/{metric_id}/download?api_key=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Download Latest Metric Data

API for downloading latest metric data

GET/metric/{metric_id}/download/latest

Authorization

HTTPBearer

Path parameters

metric_id*Metric Id

Metric Id

Query parameters

Response

200401422

Successful Response

Request

JavaScriptCurlPython

const response = await fetch('/metric/{metric_id}/download/latest?api_key=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Tournament

Get All Tournaments

API for getting all tournaments

GET/tournament/all

Response

200401

Successful Response

Body

application/json

name*Name

search_id*Search Id

description*Description

open_status*Open Status

Request

JavaScriptCurlPython

const response = await fetch('/tournament/all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get current round of tournament

API for getting current round of tournament.

GET/tournament/{tournament_search_id}/current-round

Path parameters

tournament_search_id*Tournament Search Id

Tournament Search Id

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/current-round', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get symbols supported in tournament

API for getting symbols supported in tournament

GET/tournament/{tournament_search_id}/symbols

Path parameters

tournament_search_id*Tournament Search Id

Tournament Search Id

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/symbols', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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_id*Tournament Search Id

Tournament Search Id

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/submission-types', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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_id*Tournament Search Id

Tournament Search Id

Query parameters

Body

application/json

Data

Response

201401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/submit/api?api_key=text&submission_type=text&symbol=text&model_id=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get All Submissions Time

API for getting all submissions time of user.

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

Authorization

HTTPBearer

Path parameters

tournament_search_id*Tournament Search Id

Tournament Search Id

Query parameters

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/submission-time/all?api_key=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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

Authorization

HTTPBearer

Path parameters

tournament_search_id*Tournament Search Id

Tournament Search Id

Query parameters

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/submission/overall-performance?api_key=text&submission_type=text&symbol=text&model_id=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Delete Submission

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

DELETE/tournament/{tournament_search_id}/submission

Authorization

HTTPBearer

Path parameters

tournament_search_id*Tournament Search Id

Tournament Search Id

Query parameters

Response

200401422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/tournament/{tournament_search_id}/submission?api_key=text&submission_type=text&symbol=text&model_id=text', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}