Getting Started

Create an account

Sign up at app.hermaeus.xyz. The free tier includes 10,000 requests per month — no credit card required.

Get your API key

After signing in, navigate to Settings → API Keys and create a new key. The full key is shown exactly once — copy it somewhere safe.

Keys use the sk_ prefix and should be treated as opaque strings.

Base URL

All API requests use the following base URL:

https://api.hermaeus.xyz/v1

Make your first request

Look up an entity by name:

curl -H "x-api-key: sk_your_key_here" \
  "https://api.hermaeus.xyz/v1/entities/search?q=Apple"

Or resolve a CIK directly:

curl -H "x-api-key: sk_your_key_here" \
  "https://api.hermaeus.xyz/v1/entities/resolve?system=cik&identifier=0000320193"

Both return a canonical mei (Master Entity Identifier) — use this for all subsequent entity-scoped requests.

Next steps

• Read the Authentication guide for details on key management and rate limits.
• Browse the API Reference to see all available endpoints.