Quickstart

Get a key, authenticate, and make your first API call in a few minutes.

This is the fastest path from zero to your first successful request.

1. Get an API key

Public API keys are issued by the Satellyte team and provisioned per workspace. Request one from the pricing page or your account contact. Each key maps to one workspace - all reads and writes are scoped to it.

Warning: Treat API keys as secrets. Never embed them in client-side code, and rotate immediately if a key is exposed.

2. Pick a base URL

# Production
https://api.satellyte.ai/api/v1

# Staging
https://api-staging.satellyte.ai/api/v1

3. Authenticate

Every request must include your key in the X-Satellyte-API-Key header.

X-Satellyte-API-Key: YOUR_PUBLIC_API_KEY

A missing or invalid key returns:

{ "error": { "code": "unauthorized", "message": "Missing or invalid Public API credentials." } }

4. Make your first call

Hit the health check - it needs nothing but your key, so it's the quickest way to confirm everything is wired up.

cURL

curl -i "https://api.satellyte.ai/api/v1/health" \
  -H "X-Satellyte-API-Key: YOUR_PUBLIC_API_KEY"

Python

import requests

response = requests.get(
    "https://api.satellyte.ai/api/v1/health",
    headers={"X-Satellyte-API-Key": "YOUR_PUBLIC_API_KEY"},
)
print(response.json())

JavaScript

const response = await fetch(
  "https://api.satellyte.ai/api/v1/health",
  { headers: { "X-Satellyte-API-Key": "YOUR_PUBLIC_API_KEY" } },
);
console.log(await response.json());

A 200 confirms you're in:

{ "data": { "status": "ok", "service": "public_api" } }

To check which workspace a key resolves to, call GET /account/key-info.

Common error responses

Failed requests use the standard error envelope:

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid Public API credentials."
  }
}

Common errors you may see during setup:

Status	Code	When it happens
`400`	`validation_error`	Required query parameters or request body fields are missing or invalid.
`401`	`unauthorized`	`X-Satellyte-API-Key` is missing, invalid, or expired.
`404`	`not_found`	Public API access is not enabled or the requested Public API resource is unavailable.
`429`	`rate_limit_exceeded`	The API key exceeded its configured rate limit. Retry after backing off.
`500`	`service_error`	The service could not complete the request. Retry with exponential backoff.

For the full error model and stable error codes, see Errors.

Next steps

Signals - detect buying signals on your accounts.
Radar - stand up ongoing monitoring.
Discover - build a target list.