REST-API

Konto och saldo

Ditt konto, saldot, månadens förbrukning och nyckelns scopes och miljö. Gratis och mäts inte.

http

GET /api/v1/account

Headers: Authorization: Bearer … (krävs) och Idempotency-Key (valfri).

Anropet är gratis, mäts inte och räknas inte mot någon kvot utom takten per minut. Det fungerar också när live-data är stängd, så det passar som hälsokontroll av en nyckel.

Exempel#

curl -s "https://app.bolagskvarnen.se/api/v1/account" \
  -H "Authorization: Bearer $GETBOLAG_KEY"

Om svaret#

Kontot: namn, organisationsnummer och status (till exempel active eller pending_review).
Saldot i kronor och månadens förbrukning mot månadstaket.
Nyckeln eller OAuth-anslutningen som gjorde anropet: miljö (live eller test) och scopes.
live_data_open: om live-data är öppnad. Är den false svarar live-nycklar 503 blocked_by_phase, medan testnycklar fungerar mot sandlådan.

Ett svar för en testnyckel kan se ut så här:

json

{
  "status": "ok",
  "data": {
    "account": {
      "id": "3d5f8a2c-6b1e-4f0a-9c7d-2e4b6a8c0f13",
      "name": "Exempelkunden AB",
      "org_number": "569900-0088",
      "status": "active",
      "tier": "self_service"
    },
    "credits": {
      "balance_sek": 450,
      "monthly_cap_sek": 1000,
      "used_this_month_sek": 0,
      "requests_this_month": 42,
      "searches_today": 7,
      "free_searches_per_day": 1000,
      "daily_entity_cap": 2000
    },
    "credential": {
      "type": "api_key",
      "id": "9a1c3e5f-7b2d-4c6e-8f0a-1b3d5e7f9a2c",
      "environment": "test",
      "scopes": [
        "companies:read",
        "roles:read",
        "history:read",
        "financials:read",
        "persons:read"
      ],
      "daily_cost_cap_sek": null
    },
    "live_data_open": false
  },
  "meta": {
    "request_id": "5e2a7c9d-1f3b-4a6c-8e0d-2b4f6a8c0e1d",
    "retrieved_at": "2026-10-26T09:15:00.000Z",
    "database": "Bolagskvarnen (bolagskvarnen.se)",
    "publisher": "Bolagskvarnen, ett varumärke i Bolagskällan AB (559555-5946)"
  }
}

Exakta fältnamn står i OpenAPI-specifikationen.

Kod	HTTP	Vad du gör
`unauthorized`	401	Skicka `Authorization: Bearer gb_test_…` eller `gb_live_…`. Kontrollera att hela nyckeln kom med. En OAuth-token gäller en timme; förnya den med refresh-token.
`email_not_verified`	403	Klicka på länken i bekräftelsemejlet, eller skicka ett nytt från Konto.
`user_disabled`	403	Be kontots ägare att aktivera användaren, eller använd en egen nyckel.
`rate_limited`	429	Vänta så många sekunder som `Retry-After` anger och försök igen. Se takt och tak.
`internal_error`	500	Försök igen med samma `Idempotency-Key`. Ange `request_id` om du kontaktar support.