API — Discovery & Meta

Endpoint catalog

Introspects the running FastAPI sub-app and returns one entry per route with path, HTTP methods, tag, summary, description, and the parameter list. Each parameter carries its name, location (query / path / header), required flag, type, default, numeric bounds (if any), and enum array when the parameter is Literal-typed.

Derived from in-memory route metadata — no Redis or DB I/O. Requires X-API-Key. For totally anonymous discovery use /v2/openapi.json (FastAPI built-in).

GET

endpoints

Live catalog of every v2 route

curl --request GET \
  --url https://api.example.com/endpoints \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.example.com/endpoints"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/endpoints"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/endpoints")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "No data for BTCUSDT"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "errors": []
    }
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again later."
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

Live introspection of every registered route in the API. For each endpoint you get the path, HTTP methods, tag, summary, description, and the full parameter list - including the enum array for any parameter that’s Literal-typed (so you can validate user input client-side against exactly the same values the server accepts). The catalog is derived from the running FastAPI app at request time, not hard-coded. New routes appear here automatically. Use it as a lighter alternative to /v2/openapi.json when you want a flat catalog rather than the full OpenAPI 3 schema.

API metadata

Symbol catalog

Authorizations

X-API-Key

string

header

required

Your BackQuant API key (same key as v1)

Headers

X-API-Key

string | null

Response

Successful Response

API metadata

Changelog

Live catalog of every v2 route

curl --request GET \
  --url https://api.example.com/endpoints \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.example.com/endpoints"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/endpoints', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/endpoints",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/endpoints"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/endpoints")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/endpoints")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "No data for BTCUSDT"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "errors": []
    }
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again later."
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-29T12:00:00Z"
  }
}

​See also

API metadata

Symbol catalog

Authorizations

Headers

Response

See also