Dataras Python SDK

Official Python client for the Dataras market-data API.

Install

uv add dataras
# or
pip install dataras

pandas is included so export="pandas" works out of the box. For Parquet files (export="parquet"), also install:

pip install 'dataras[export]'

Quickstart

from dataras import DatarasClient

with DatarasClient() as client:
    client.auth.login("YOUR_USERNAME", "YOUR_PASSWORD")
    page = client.reference.list_tickers(search="فولاد", limit=10)
    for ticker in page.results:
        print(ticker.ticker, ticker.name)

    # Optional: get a pandas DataFrame
    df = client.fundamental.list_meta(
        type="balance_sheet",
        isin="IRTKMOFD0001",
        export="pandas",
    )

Default base URL is https://api.dataras.ir — you do not need to pass base_url. Override only when needed:

client = DatarasClient(base_url="https://staging.example.com")

Environment variables (opt-in via DatarasClient.from_env()):

• DATARAS_BASE_URL (optional; defaults to https://api.dataras.ir)
• DATARAS_ACCESS_TOKEN
• DATARAS_API_KEY
• DATARAS_API_KEY_HEADER (required when using an API key; header name is not yet in the OpenAPI contract)

Async

from dataras import AsyncDatarasClient

async with AsyncDatarasClient(access_token="...") as client:
    page = await client.reference.list_tickers(search="فولاد")

Documentation

Build the English documentation site:

uv sync --extra docs
cd docs && make en

Generate coverage manifests and validate OpenAPI documentation status:

uv run python scripts/generate_doc_manifests.py
uv run python scripts/check_docs_coverage.py

See docs/DOCUMENTATION_AUDIT.md for architecture notes and known gaps.