developer docs · stable schema · locked by default

LiMiT Quant API

The LiMiT Quant API returns today’s 5 tickets in a consistent JSON schema. By default, sensitive fields are locked (levels and direction). Unlock access with a key or via credits (website session). This page documents endpoints, authentication methods, production usage patterns, and the OpenAPI/Swagger docs.

View Endpoints OpenAPI & Swagger Copy Examples Open Dashboard

Base path /quant/api/ Locked-by-default schema Key unlock + credits unlock

Quick Test

LIVE

Public smart feed:

https://www.limitquant.com/api/tickets

Full feed (key):

https://www.limitquant.com/api/tickets/full?key=YOUR_KEY

OpenAPI docs

Machine-readable spec: /quant/api/openapi.json

Swagger UI: /quant/api/docs/

What is locked?

• Direction: action, policy (key-only)
• Levels: entry, take_profit, stop
• Public responses keep schema stable for integration.

Credits unlock (website)

Credits unlock reveals levels for a pair (UTC day). Direction remains locked unless a key is used.

Authentication

Keys are accepted three ways. Query parameter is easiest for browser testing. Headers are recommended for production.

• Query: ?key=YOUR_KEY
• Header: Authorization: Bearer YOUR_KEY
• Header: X-Api-Key: YOUR_KEY

See curl examples Error format

Verify a Key

Use the verify endpoint to check if a key is active. This returns a JSON response suitable for automation.

GET

https://www.limitquant.com/api/key/verify?key=YOUR_KEY

Response:

JSON

{"valid":true,"tier":"retail"}

OpenAPI & Swagger

The API publishes a machine-readable OpenAPI spec and a Swagger UI page. Use the spec to generate clients, validate schemas, and automate integrations.

OpenAPI spec (JSON)

Use this for client generation (OpenAPI 3.0.x). Values in example are doc-only placeholders.

GET

https://www.limitquant.com/api/openapi.json

Open spec Open in Swagger Editor

Swagger UI

Interactive documentation for endpoint exploration. Use the “Authorize” button to paste your key (best for manual testing).

HTML

https://www.limitquant.com/api/docs/

Open Swagger UI Error formats

Endpoints

All endpoints are under /quant/api/. Responses are JSON. The schema is stable.

Smart Tickets Feed

Recommended

Developer-friendly entry point. Always returns the same schema. Locked by default. If you’re logged in and unlocked pairs via credits, those pairs show real levels. Direction stays locked unless a key is used.

GET

https://www.limitquant.com/api/tickets

Full Tickets Feed

Key required

Full ticket payload. Includes direction and levels. Requires a valid key.

GET

https://www.limitquant.com/api/tickets/full?key=YOUR_KEY

Credits pricing

Returns credits unlock cost and pack list for the website flow.

GET

https://www.limitquant.com/api/credits/pricing

Credits balance

Returns credits balance. Works for logged-in users (cookie session). Keys may also return a balance if bound in DB.

GET

https://www.limitquant.com/api/credits/balance

Unlock a pair (credits)

Charges credits once per UTC day and unlocks the pair for the session. Levels become visible for that pair in the smart feed. Direction remains locked unless a key is used.

POST

https://www.limitquant.com/api/credits/unlock_pair?pair=BTC/USD&charge=1

List unlocked pairs

Returns unlocked pairs for today (UTC day). Useful for client-side gating.

GET

https://www.limitquant.com/api/unlocks/list

Examples

Copy-paste examples for curl, JavaScript, and Python. Replace YOUR_KEY.

curl

Public smart feed

curl -s "https://www.limitquant.com/api/tickets"

Full feed (key)

curl -s "https://www.limitquant.com/api/tickets/full?key=YOUR_KEY"

Full feed (Bearer header)

curl -s "https://www.limitquant.com/api/tickets/full" -H "Authorization: Bearer YOUR_KEY"

JavaScript

Fetch smart feed

const r = await fetch("/quant/api/tickets", { credentials: "include" });
const data = await r.json();
console.log(data);

Fetch full feed (key)

const KEY = "YOUR_KEY";
const r = await fetch("/quant/api/tickets/full", {
  headers: { "Authorization": "Bearer " + KEY }
});
const data = await r.json();
console.log(data);

Python

requests

import requests

KEY = "YOUR_KEY"
url = "https://www.limitquant.com/api/tickets/full"
r = requests.get(url, headers={"Authorization": f"Bearer {KEY}"}, timeout=15)
r.raise_for_status()
print(r.json())

Errors

API errors are returned as JSON when Nginx does not intercept them. If you still see HTML 403 pages, disable intercepting errors for /quant/api/ in Nginx.

Forbidden (missing/invalid key)

JSON

{"ok":false,"err":"forbidden"}

Unauthorized (no session)

JSON

{"ok":false,"err":"unauthorized"}

Nginx note

If you see HTML error pages for API calls, set proxy_intercept_errors off; inside: location ^~ /quant/api/