XCREENER Docs
XQLHTTP API

SDKs

Official client libraries for XQL.

Official SDK libraries make it easier to integrate XQL into your applications. These libraries handle authentication, request formatting, and response parsing.

Python

The official Python SDK provides a typed client for the XQL HTTP API.

Repository: xcreener/xcreener-sdk-python

Install from PyPI:

pip install xcreener
# or with pandas support:
# pip install 'xcreener[pandas]'

Basic usage:

from xcreener import Xcreener

xc = Xcreener()  # reads XCREENER_API_KEY environment variable

query = """
market = "CRYPTO"
timeframe = h1
let rsi14 = rsi(14)
columns = [rsi14, volume]
sort = volume desc
limit = 5

rsi14 < 30 and close > d::sma(200)
"""

# Run the query and iterate over results
for match in xc.run(query):
    print(match.symbol, match["rsi14"], match["volume"])

The SDK provides four methods:

  • validate(query) — Parse and plan a query without executing (free, not metered)
  • explain(query) — Get a human-readable explanation of what a query does (free, not metered)
  • run(query) — Execute a query and get results (metered against your quota)
  • usage() — Check your remaining quota for the day

See the Python SDK repository for detailed documentation and error handling.

On this page