πŸ”€API Reference Draft

Comprehensive API documentation for the AIQuant platform.

Overview

The AIQuant API provides programmatic access to AI-powered quantitative trading data, analyses, and signals for cryptocurrency markets. This API allows developers, traders, and funds to integrate AIQuant's advanced trading intelligence directly into their applications and systems.

With the AIQuant API, you can access performance reports, trade logs, evaluation results, alpha signals, and trading playbooks across multiple blockchain networks. The API is designed to support a wide range of use cases from simple data retrieval to complex trading strategy implementation.

Authentication

All API requests must be authenticated using an API key. To make authenticated requests, include your API key in the request header:

X-API-Key: your_api_key_here

Getting Your API Key

API keys are tied to your AIQuant subscription plan. To obtain an API key:

  1. Subscribe to one of the API plans (Basic, Growth, or Enterprise)

  2. Navigate to the API section in your profile settings

  3. Generate a new API key

For security reasons, store your API key securely and do not share it publicly.

Rate Limits and Quotas

The AIQuant API implements daily request limits based on your subscription plan:

Plan
Daily Request Limit
Chain Access
Primaray Use Case

Basic API

100 requests/day

Up to 1 chain

Developers & Hobbyists

Growth API

500 requests/day

Up to 2 chains

Scaling Products

Enterprise API

5,000 requests/day

Unlimited chains

Quant Funds & Advanced Traders

Rate limit information is included in the response headers:

When you exceed your daily limit, the API will return a 429 Too Many Requests response.

API Plans and Features

AIQuant offers three API subscription plans with different capabilities:

Basic API Plan

  • Performance reports & trade logs

  • Quick evaluation summaries

  • Support: Email

Growth API Plan

  • Everything in Basic, plus:

  • Detailed evaluation reports

  • Realtime alpha signals

  • Basic trading playbook

  • Support: Email + Telegram

Enterprise API Plan

  • Everything in Growth, plus:

  • Advanced trading playbook

  • AI-powered strategy optimizations

  • Support: Email + Telegram + Slack

Available Endpoints

Base URL: https://aiquant.fun/apiarrow-up-right

All endpoints should be prefixed with this base URL. For example, to access the Trade Statistics endpoint, use: https://aiquant.fun/api/trades/stats

Performance & Trades

Evaluation Results

Alpha Signals

Trading Playbook

Strategy Optimization


Performance & Trades

Trade Statistics

Trade Metrics

GET /api/trades/stats

Retrieves aggregated metrics for trades, including total trades, volume, and weekly performance changes.

Query Parameters:

  • quantId (integer, optional): Filter metrics by specific quant ID

Response:

Trade History

Trade List

GET /api/trades

Retrieves paginated trade history with filtering options.

Query Parameters:

  • quantId (integer, optional): Filter by quant ID

  • page (integer, optional): Page number for pagination

  • pageSize (integer, optional): Number of trades per page

  • sortBy (string, optional): Field to sort by

  • sortOrder (string, optional): Sort direction (asc or desc)

  • filterStatus (string, optional): Filter by trade status

  • search (string, optional): Search term for tokens

  • startDate (string, optional): Filter by start date (ISO format)

  • endDate (string, optional): Filter by end date (ISO format)

  • chain (string, optional): Filter by blockchain network

  • positionClosed (string, optional): Filter by position status (true, false, or all)

  • isTrackingEnabled (string, optional): Filter by tracking status (true, false, or all)

Response:

Trade Details

Trade Information

GET /api/trades/:id

Retrieves detailed information about a specific trade.

Path Parameters:

  • id (integer, required): Trade ID

Response:

Evaluation Results

Latest Evaluation Results

Evaluation Results

GET /api/eval-results

Retrieves the latest token evaluation results with filtering options.

Query Parameters:

  • limit (integer, optional): Maximum number of results to return

  • offset (integer, optional): Number of results to skip

  • chain (string, optional): Filter by blockchain network

  • search (string, optional): Search term for tokens

  • quantId (string, optional): Filter by quant ID

  • passed (string, optional): Filter by pass/fail status

  • uniqueTokensOnly (string, optional): Return only unique tokens

  • onlyScored (string, optional): Return only scored evaluations

  • timeTo (string, optional): End time for results (ISO format)

  • timeFrom (string, optional): Start time for results (ISO format)

  • evaluationResultType (string, optional): Filter by evaluation type

Response:

Evaluation Timeseries

Evaluation Trends

GET /api/eval-timeseries

Retrieves evaluation data as a time series.

Query Parameters:

  • timeFrom (string, required): Start time for timeseries (ISO format)

  • timeTo (string, required): End time for timeseries (ISO format)

  • quantId (string, optional): Filter by quant ID

  • returnAllQuants (string, optional): Include all quants in results

Response:

Evaluation Count

Evaluation Counts

GET /api/eval-count

Retrieves the count of evaluations over time.

Query Parameters:

  • timeFrom (string, required): Start time (ISO format)

  • timeTo (string, required): End time (ISO format)

  • quantId (string, optional): Filter by quant ID

  • returnAllQuants (string, optional): Include all quants in count

Response:

Evaluation Details

Evaluation Details

GET /api/eval-details

Retrieves detailed information about a specific evaluation.

Query Parameters:

  • evaluationId (string, required): ID of the evaluation

Response:

Evaluation History

Evaluation History

GET /api/eval-history

Retrieves the evaluation history for a specific token or evaluation.

Query Parameters:

  • evaluationId (string, required): ID of the evaluation

  • take (integer, optional): Maximum number of results to return

  • skip (integer, optional): Number of results to skip

  • excludeTypes (string, optional): Comma-separated list of evaluation types to exclude

Response:

Token OHLCV Data

Market Data

GET /api/eval-ohlcv

Retrieves open, high, low, close, volume (OHLCV) data for a token.

Query Parameters:

  • tokenId (string, required): ID of the token

  • timeframe (string, optional): Timeframe for data points (e.g., '1h', '4h', '1d')

  • limit (integer, optional): Maximum number of data points to return

Response:

Alpha Signals

Alpha Signals List

Alpha Signals

GET /api/alpha-signals

Retrieves a list of alpha signals with filtering options.

Query Parameters:

  • quantId (integer, optional): Filter by quant ID

  • limit (integer, optional): Maximum number of results to return

  • chain (string, optional): Filter by blockchain network

  • includeTokenDetails (boolean, optional): Include detailed token information

  • search (string, optional): Search term for tokens

Response:

Alpha Signal Details

Signal Details

GET /api/alpha-signals/:tokenId

Retrieves detailed information about a specific alpha signal.

Path Parameters:

  • tokenId (integer, required): ID of the token

Query Parameters:

  • quantId (integer, optional): ID of the quant

Response:

Trading Playbook

Degen Configuration

Trading Playbook Configuration

GET /api/degen/config

Retrieves the trading playbook configuration for a quant.

Query Parameters:

  • quantId (integer, required): ID of the quant

  • configGroupId (string, optional): ID of the configuration group

Response:

Strategy Optimization

Optimization Dashboard

Strategy Dashboard

GET /api/refine-eval/dashboard

Retrieves the strategy optimization dashboard with performance metrics and recommendations.

Query Parameters:

  • quantId (integer, optional): ID of the quant

Response:

Run Analysis

Analysis Executor

POST /api/refine-eval/analyze

Executes a strategy analysis to generate optimization recommendations.

Request Body:

  • quantId (integer, optional): ID of the quant to analyze

Response:

Apply Recommendation

Apply Recommendation

POST /api/refine-eval/recs/:id/apply

Applies a specific optimization recommendation to the trading strategy.

Path Parameters:

  • id (integer, required): ID of the recommendation to apply

Response:

Getting Started

1. Create an AIQuant Account

Visit AIQuant.funarrow-up-right to sign up for an account.

2. Launch a Quant

Create and configure your AI-powered trading quant. This will be your primary trading agent that generates signals and evaluations.

3. Select an API Plan

Choose the API plan that best suits your needs:

  • Basic API: For indie builders and hobbyist developers

  • Growth API: For scaling products, mid-sized funds, and onchain tools

  • Enterprise API: For quant funds, trading platforms, and strategic innovators

4. Generate an API Key

Once subscribed to an API plan:

  1. Navigate to the API section in your profile settings

  2. Click "Generate New API Key"

  3. Store your API key securely

5. Start Integrating

Add your API key to the request headers:

Test your integration with a simple request:

Code Examples

JavaScript/Node.js

Python


For urgent assistance, please contact our developer relations team at [email protected]

Last updated