NestQuant Tournament
  • About Us
  • Homepage
  • NestQuant Tournament
    • Overview
    • Raw Data
      • Tournament
      • Blockchain
        • Centralized Exchanges
      • Stocks
        • Stocks at exchange
        • ETF & Indices
      • Forex
        • Raw currency pairs
      • Economy
        • Federal Reserve Economic Data
      • API documentation
    • Reward
    • Return and Risk Tournament
      • Introduction
      • Labeling Method
      • Correlation (CORR)
      • Movement Score (MS)
  • Connect
    • Facebook
    • Twitter
    • Discord
    • GitHub
Powered by GitBook
On this page
  1. NestQuant Tournament
  2. Raw Data

API documentation

PreviousFederal Reserve Economic DataNextReward

Last updated 1 year ago

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

Data

Tournament

repository

Get Categories

get

API for getting metric categories

Responses
Responseany
get
GET /metric/categories HTTP/1.1
Host: 
Accept: */*

No content

Download Metric Data

get

API for downloading metric data

Authorizations
Path parameters
metric_idstringRequired

Metric Id

Query parameters
api_keystringRequired

API Key

symbolstringOptional

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

resolutionstringOptional

Resolution, either 1h or 1d

Default: 1h
Responses
get
GET /metric/{metric_id}/download?api_key=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download Latest Metric Data

get

API for downloading latest metric data

Authorizations
Path parameters
metric_idstringRequired

Metric Id

Query parameters
api_keystringRequired

API Key

symbolstringOptional

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

resolutionstringOptional

Resolution, either 1h or 1d

Default: 1h
Responses
get
GET /metric/{metric_id}/download/latest?api_key=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get All Tournaments

get

API for getting all tournaments

Responses
get
GET /tournament/all HTTP/1.1
Host: 
Accept: */*

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

Get current round of tournament

get

API for getting current round of tournament.

Path parameters
tournament_search_idstringRequired

Tournament Search Id

Responses
Responseany
get
GET /tournament/{tournament_search_id}/current-round HTTP/1.1
Host: 
Accept: */*

No content

Get symbols supported in tournament

get

API for getting symbols supported in tournament

Path parameters
tournament_search_idstringRequired

Tournament Search Id

Responses
Responseany
get
GET /tournament/{tournament_search_id}/symbols HTTP/1.1
Host: 
Accept: */*

No content

Get all submission types supported in tournament

get

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

Path parameters
tournament_search_idstringRequired

Tournament Search Id

Responses
Responseany
get
GET /tournament/{tournament_search_id}/submission-types HTTP/1.1
Host: 
Accept: */*

No content

Get All Submissions Time

get

API for getting all submissions time of user.

Authorizations
Path parameters
tournament_search_idstringRequired

Tournament Search Id

Query parameters
api_keystringRequired

API Key

submission_typestringOptional

Submission type

symbolstringOptional

Symbol

model_idstringOptional

Model Id

Responses
Responseany
get
GET /tournament/{tournament_search_id}/submission-time/all?api_key=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get User Overall Performance

get

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

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_timeintegerOptional

Submission time

Responses
Responseany
get
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

Delete Submission

delete

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

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_timeintegerOptional

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

Responses
Responseany
delete
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
  • Data
  • GETGet Categories
  • GETDownload Metric Data
  • GETDownload Latest Metric Data
  • Tournament
  • GETGet All Tournaments
  • GETGet current round of tournament
  • GETGet symbols supported in tournament
  • GETGet all submission types supported in tournament
  • POSTSubmit Results Via Api
  • GETGet All Submissions Time
  • GETGet User Overall Performance
  • DELETEDelete Submission

Submit Results Via Api

post

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

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[]Optional
Responses
Responseany
post
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