XCREENER Docs
XQLHTTP API

Authentication

Generate an API key and authenticate your requests.

Generating a Key

Generate your API key from your account menu (click your account icon, then API Key), at xcreener.com/account/api-key. You get one key per account: generating a new one immediately replaces (and invalidates) any existing key.

The raw key is shown exactly once

XCREENER stores only a hash of your key, never the raw value. Copy it when it's generated: you can't view it again afterward, only regenerate a new one (which invalidates the old one everywhere it's in use, including any MCP client or script configured with it).

Sending Your Key

Every request to /xql/validate, /xql/explain, /xql/run, and the MCP endpoint requires an Authorization header using the Bearer scheme:

Authorization: Bearer <your-api-key>
curl https://api.xcreener.com/xql/validate \
  -H "Authorization: Bearer <your-api-key>" \
  --data-raw 'market = "CRYPTO"
timeframe = h1
rsi(14) < 30'

Subscription Requirement

A valid API key is required on every request. /xql/validate and /xql/explain work with any recognized key, including a free-tier account's, and are never metered: they never run the query against market data, so there's nothing to gate.

/xql/run also works on any recognized key, including free tier, but is metered against a daily quota tied to your subscription: see Rate Limits for the per-tier numbers and how to make the most of them.

Condition/xql/validate, /xql/explain/xql/run
No Authorization header401401
Key doesn't match any stored key401401
Key is valid, daily quota exhaustedrequest proceeds normally429
Key is valid, quota remainingrequest proceeds normallyrequest proceeds normally

On this page