Getting started

Five minutes from landing page to your first authenticated API call.

1. Create an account

Go to /register and sign up with an email and password. We'll send a verification link — click it, then sign in at /login.

2. Generate an API key

From the dashboard, open Settings and click Create API key. Give it a descriptive name (e.g. "My trading bot") and hit Create.

The raw key is shown exactly once — in the format:

ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Copy it immediately and store it somewhere secure (password manager, secret manager, .env file outside version control). If you lose it, revoke and create a new one.

3. Sanity check without auth

The /public/news/landing endpoint returns the last ~24h of articles and needs no authentication. Great for a connectivity check:

curl http://localhost:3003/public/news/landing

You should get a JSON array of articles, or [] if the ingest pipeline has no data yet.

4. Your first authenticated request

Use the key you just copied as a Bearer token:

curl -H "Authorization: Bearer ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  http://localhost:3003/public/news?symbol=AAPL&minImpact=0.5

Response shape is identical to the landing endpoint — an array of NewsArticleDto objects with analysis, symbols, sentiment, and impactScore.

Next steps

• Authentication — header formats, rate limits, rotation.
• Endpoints — full query parameter reference.
• Examples — JS and Python snippets.