Skip to main content

Get an API key

Visit polyedge.dev to create an account and generate your API key.
Keep your API key secret. Do not expose it in client-side code, public repositories, or anywhere it can be read by others.

Pass the key in your requests

Include your API key in the X-PolyEdge-Key header on every request.
curl https://api.polyedge.dev/v1/analytics/leaderboard \
  -H "X-PolyEdge-Key: YOUR_API_KEY"

Node.js

import PolyEdgeClient from './polyedge.js';

const client = new PolyEdgeClient('YOUR_API_KEY');
// The X-PolyEdge-Key header is set automatically on every request.

Python

from polyedge import PolyEdgeClient

client = PolyEdgeClient('YOUR_API_KEY')
# The X-PolyEdge-Key header is set automatically on every request.

Access tiers

PolyEdge has two access tiers.
DemoFull access
Results per requestMax 20Up to 100
Pagination (offset)Must be 0Unrestricted
All endpointsYesYes
Real-time streamYesYes
Demo keys are useful for testing and prototyping. Upgrade to full access at polyedge.dev when you’re ready to paginate deeper or retrieve larger result sets.

Error reference

401 Unauthorized

A 401 response means the request was rejected due to an authentication problem.
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key."
}
Common causes:
  • The X-PolyEdge-Key header is missing from the request.
  • The API key is invalid, malformed, or has been revoked.
  • The key was passed in the wrong header name (e.g., Authorization instead of X-PolyEdge-Key).