Docs/Getting started

Getting started

Sign in to the console, run a live market-data query, submit a compute job, and download an artifact.

Access the console

  1. Open https://particles-data.com/pqc (or Sign in from the company home), then sign in with an approved account, or Register (registration is approval-gated).
  2. After login you land on Dashboard. Use the left nav for Datasets, Explore, Jobs, Job Compose (placeholder), Artifacts, Usage, Plans, and Settings.

Browse data and run a query

  1. Open Datasets to see research datasets and live coverage from the market-data manifest.
  2. Open Explore — pick a dataset, ticker, and a single trade date.
  3. Run the query. Results are capped for interactive use; a row limit is recommended.
  4. Optionally Download CSV, or Export as job (data_export). If you set a limit on Explore, the export job keeps that limit.

Interactive Explore is single-day. For multi-day exports, use Jobs → data_export.

If Explore reports that the data plane is disabled, a platform operator must turn it on for your organization (Admin → Customers).

Submit a compute job

Production jobs use the Athena data plane (not synthetic demo files), except as noted below.

  1. Open Jobs and choose a type:
    • factor_batch — live factor / target batch for a trade date and ticker
    • data_export — parquet export of compacted Athena data (omit limit only if you intend a full-day pull; that uses more quota)
    • normalized_export — parquet export from the official normalized quotes/trades lake; production currently accepts one symbol and one dataset per Job while the batch planner is staged (not Athena)
    • strategy_validation — still a demo report until a strategy spec is provided
  2. Submit and watch status: queued → running → succeeded (or failed / canceled).
  3. Open Artifacts (or “View artifacts” from the job detail) to preview or download files.

Job Compose in the sidebar is a reserved page for a later web authoring flow. It does not replace the Jobs form above.

Usage and quotas

Usage shows this month’s data reads, compute time, and storage. Free organizations are hard-capped; Pro is a higher multiplier. Exceeding a limit returns an error on the next query or job.

Your plan may come from Plans → Upgrade (when Stripe is configured) or from a platform operator. After a plan change, sign in again so the console session picks up the new tier.

API keys and Python SDK

Create a key under Settings. Use it as Authorization: Bearer pk_live_…. Production API origin is https://particles-data.com/backend (Nginx strips /backend/ onto the API):

from pqc import Client

with Client(
    api_key="pk_live_…",
    base_url="https://particles-data.com/backend",
) as client:
    client.catalog.list_datasets(group="market_data")
    client.data.query(
        dataset_group="market_data",
        dataset_type="quotes_v1",
        ticker="QQQ",
        start_date="2024-01-02",
        end_date="2024-01-02",
        limit=5,
    )
    client.jobs.create(
        "factor_batch",
        spec={
            "trade_date": "2024-01-02",
            "tickers": ["QQQ"],
            "universe": {"universe_mode": "explicit", "tickers": ["QQQ"]},
        },
    )

Current CodeArtifact client is particles-quant==0.3.3. Besides data.query and jobs, client.aggregates reads platform daily/minute bars (rank is volume only). SDK 0.3.3 also includes client.normalized.export_day; production currently permits its one-symbol, one-dataset form while multi-symbol/combined artifacts are staged. Normalized quotes/trades (catalog, sync query, normalized_export) are in Normalized quotes & trades. Datasets / Explore still list compacted Athena types only. Do not set "demo": true if you want live compute.

To put this client on a research EC2 / Remote IDE (pqc init, venv, CodeArtifact, and the managed research store or BYOS), see Research environment.

Organization roles

RoleTypical access
OwnerFull org control
AdminInvite and manage members
MemberQuery, jobs, own API keys
ViewerRead-only

Invite and role changes live under Settings.