Documentation

Account-specific credit balances are private, so this public copy uses placeholders for credit values.

Authentication

Send your API key with either an Authorization bearer header or an x-api-key header.

Authorization: Bearer alt_live_your_key_here

x-api-key: alt_live_your_key_here

Credits

Credits control unlocks. Relationship rows and metrics consume credits when they are unlocked. Per-request limits are only safety limits; they are not monthly entitlements.

Credits remainingAccount balance
Credits grantedPlan allowance

Search entities

Use entity search to find the exact entity key before querying relationships.

curl "https://altsets.com/api/v1/entities/search?q=amazon&limit=5" \
  -H "Authorization: Bearer alt_live_your_key_here"

Query relationships

Query supplier or customer relationships for a company. Add a period when you want an as-of historical snapshot.

curl "https://altsets.com/api/v1/relationships?entityKey=AMAZON%20COM%20INC&direction=customers&limit=50&unlockedOnly=true" \
  -H "Authorization: Bearer alt_live_your_key_here"

curl "https://altsets.com/api/v1/relationships?entityKey=AMAZON%20COM%20INC&direction=customers&period=201205&limit=50&unlockedOnly=true" \
  -H "Authorization: Bearer alt_live_your_key_here"

Response shape

{
  "data": [
    {
      "locked": true,
      "unlockToken": "rel_...",
      "counterpartyRole": "customer",
      "hasMetrics": true,
      "supplier": {
        "entityKey": "AMAZON COM INC",
        "symbol": "AMZN",
        "name": "AMAZON COM INC",
        "country": "US"
      },
      "customer": {
        "entityKey": "SAGE GROUP PLC",
        "symbol": "SGE",
        "name": "SAGE GROUP PLC",
        "country": "GB"
      },
      "firstSeen": "2012-05",
      "lastSeen": "2012-05",
      "metrics": null
    }
  ],
  "meta": {
    "status": "ok",
    "entityKey": "AMAZON COM INC",
    "direction": "customers",
    "period": 201205,
    "plan": "Your plan"
  }
}