Alterscope Developer API

This walks you from an API key to a parsed response in three steps. You’ll need a terminal and either curl, Python, or Node.

1. Get an API key

Create a key in the Developer Portal under your organization’s API Keys settings. A Free-tier key works for this guide. Keys are prefixed sk_live_.

Store the key in an environment variable, never in source control. Rotate it immediately if it leaks.

export ALTERSCOPE_API_KEY="sk_live_..."

2. Make your first request

This fetches one yield opportunity so you can see the envelope shape:

curl -sS -H "Authorization: Bearer $ALTERSCOPE_API_KEY" \
  "https://api.alterscope.org/v2/yield/opportunities?limit=1"

import os, requests

resp = requests.get(
    "https://api.alterscope.org/v2/yield/opportunities",
    params={"limit": 1},
    headers={"Authorization": f"Bearer {os.environ['ALTERSCOPE_API_KEY']}"},
    timeout=20,
)
resp.raise_for_status()
body = resp.json()
print(body["meta"]["_agentic"]["freshness"]["status"])

const resp = await fetch(
  "https://api.alterscope.org/v2/yield/opportunities?limit=1",
  { headers: { Authorization: `Bearer ${process.env.ALTERSCOPE_API_KEY}` } },
);
if (!resp.ok) throw new Error(`Alterscope API returned ${resp.status}`);
const body = await resp.json();
console.log(body.meta._agentic.freshness.status);

3. Read the response

A successful call returns 200 and a JSON envelope. The result is under data; the freshness and quality signal is under meta._agentic:

{
  "data": [ { "...": "one yield opportunity" } ],
  "meta": {
    "request_id": "req_…",
    "_agentic": {
      "freshness": { "status": "fresh" },
      "quality_gate": { "verdict": "pass" }
    }
  }
}

You’re done when: the call returns 200, data contains one opportunity, and meta._agentic.freshness.status prints. If you got a 401 or 403, check Authentication and Scopes; for 429, see Rate limits; for any other status, see Errors.

Next steps

SDKs

TypeScript, Python, and Go clients.

Response envelope

The full data + meta contract.

Guides

Worked recipes for common workflows.

API reference

Every endpoint and parameter.

​1. Get an API key

​2. Make your first request

​3. Read the response

​Next steps

SDKs

Response envelope

Guides

API reference

1. Get an API key

2. Make your first request

3. Read the response

Next steps