portfolIQ
Documentation

Authentication

Authenticate your requests with an API key.

Authentication

All requests to /v1/* endpoints require an API key passed via the X-API-Key header.

API Key

Every request must include:

X-API-Key: YOUR_API_KEY

Get your key

API keys are available on the pricing page. The Free tier requires no payment.

API keys are generated automatically when you create an account on the pricing page.

Using your key

curl https://api.portfoliq.io/v1/assets \
  -H "X-API-Key: YOUR_API_KEY"

Error responses

CodeMeaning
401 UnauthorizedMissing or invalid X-API-Key header
403 ForbiddenValid key but insufficient tier for this endpoint — check upgrade_url in response
429 Too Many RequestsRate limit exceeded — check X-RateLimit-Reset header

401 example

{
  "error": "unauthorized",
  "message": "Missing or invalid X-API-Key header."
}

403 example (scope gate)

{
  "error": "forbidden",
  "message": "This endpoint requires the 'onchain:read' scope.",
  "upgrade_url": "https://portfoliq.io/pricing"
}

Not financial advice. Not a fatwa. Methodology disclosed.