Getting started

Three steps to your first result: create a key, send a request, read the response. Everything else in these pages builds on this.

1. Create your API key

Sign in and open your dashboard, then choose Generate API key. The key is shown there and you can copy it with one click. You can delete it at any time — every tool using it stops working immediately — and generate a new one afterwards.

2. Keep the key out of your code

The key identifies you, so treat it like a password: keep it out of source control, out of URLs and out of client-side code that visitors can read. The examples on these pages expect it in an environment variable.

shell
export ALGOUM_API_KEY="paste-your-key-here"

3. Send your first request

Every endpoint expects the key as a bearer token in the Authorization header. This request returns the insider trades reported over the last seven days, newest first:

curl
curl -H "Authorization: Bearer $ALGOUM_API_KEY" \
  "https://api.algoum.de/v1/insider/recent?days=7&limit=1"

4. Read the response

Every response has the same two parts. data is the payload you asked for — an object for a single record, an array for a list. meta describes the response itself: which request it belongs to, where the data came from, how fresh it is, and how to fetch the next page.

response
{
  "meta": {
    "request_id": "req_01K4W7YV8Q2N",
    "source": "sec_edgar",
    "data_freshness": "2026-07-13T21:05:00-04:00",
    "next_cursor": "eyJvIjoyfQ",
    "warnings": []
  },
  "data": [
    {
      "ticker": "AAPL",
      "insider_name": "Cook Timothy D",
      "role": "officer",
      "role_detail": "Chief Executive Officer",
      "side": "sell",
      "shares": 511000,
      "price": { "amount": 190.12, "currency": "USD" },
      "transaction_date": "2026-07-10",
      "filed_at": "2026-07-11T21:03:00-04:00",
      "filing_id": "0000320193-26-000073",
      "source_url": "https://www.sec.gov/Archives/edgar/data/320193/..."
    }
  ]
}

5. Fetch the next page

Lists are paged. Pass the next_cursor from meta back as cursor to continue where you stopped. When next_cursor is null, you have reached the end.

curl
curl -H "Authorization: Bearer $ALGOUM_API_KEY" \
  "https://api.algoum.de/v1/insider/recent?days=7&limit=1&cursor=eyJvIjoyfQ"

6. When a request fails

Errors use one shape as well, with a stable code you can branch on and a request_id worth quoting in a support request. A missing or mistyped key looks like this:

401 Unauthorized
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid API key.",
    "request_id": "req_01K4W7YV8Q2N"
  }
}

Where to go next

Conventions
The rules that hold for every endpoint: paging, filtering, time zones, errors, rate limits.
Endpoint reference
All endpoints with parameters, response fields and a ready-to-run example each.
Event stream
Receive material company events as they are published instead of polling.
Swagger UI
Send requests with your own key straight from the browser.