Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.alterscope.org/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Create an API key

1

Sign in

Open the Developer Portal and sign in. New accounts get the Free tier automatically.
2

Create a key

Under API Keys, click New key. Give it a label (e.g. local-dev) and select scopes. The default read:yield is enough for the first request.
3

Copy the secret

The key starts with sk_live_. Copy it now. The secret is shown once and never again.
Store the key in an environment variable, not in source control. Rotate immediately if leaked.

​
2. Make your first request

export ALTERSCOPE_API_KEY="sk_live_..."

curl -H "Authorization: Bearer $ALTERSCOPE_API_KEY" \
  "https://api.alterscope.org/v2/yield/opportunities?limit=5&risk_band=1"
A successful response carries the standard envelope: 
{
  "data": [ ... ],
  "meta": {
    "request_id": "req_01HX...",
    "_agentic": {
      "schema_version": "2.0.0",
      "freshness": { "status": "fresh", "as_of": "2026-04-27T08:30:00Z" },
      "quality_gate": "passed"
    }
  }
}

​
3. Read the response

The envelope is consistent across every endpoint:
  • data is the operation payload (object or array, depending on the route).
  • meta.request_id is what you cite in support tickets.
  • meta._agentic.freshness.status tells your agent whether the data is fresh, approaching_stale, stale, unverifiable, or not_applicable. Honor it.
  • meta._agentic.quality_gate is passed or failed. Treat failed as soft-error and surface to the caller.

​
Next steps

Authentication

Scopes, key rotation, and how to revoke a leaked key.

Rate limits

Per-tier limits, response headers, and 429 retry guidance.

Recipes

Six runnable end-to-end flows.

API Reference

Every public operation with try-it-out.