REST-API
Hämta bolag
Bolagsprofil: namn, form, status, säte och bransch. Med detail=full även adresser, F-skatt, moms, verksamhet, tidigare namn och aktiekapital.
http
GET /api/v1/companies/{org_number}| Operation | Scope | Pris per uppslag |
|---|---|---|
get_company (bolag, kort profil) | companies:read | 0,05 kr |
get_company_full (bolag, hela profilen (detail=full)) | companies:read | 0,10 kr |
Parametrar#
| Namn | Var | Typ | Standard | Beskrivning |
|---|---|---|---|---|
org_number (krävs) | path | string | – | Organisationsnummer, tio siffror med eller utan bindestreck (569900-0013 eller 5699000013). Tolv siffror med sekel går också. |
detail | query | "concise" | "full" | concise | concise ger en kort profil (cirka 300 tokens). full ger hela profilen och kostar mer. |
Headers: Authorization: Bearer … (krävs) och Idempotency-Key (valfri).
Exempel#
Exemplen saknas just nu
Svaren från sandlådan kunde inte genereras i den här miljön. Anropen fungerar som beskrivet.
Kort profil#
curl -s "http://localhost:3020/api/v1/companies/569900-0013" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Hela profilen#
bash
curl -s "http://localhost:3020/api/v1/companies/569900-0013?detail=full" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Bolaget finns inte#
bash
curl -s "http://localhost:3020/api/v1/companies/569900-0096" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Felaktigt organisationsnummer#
bash
curl -s "http://localhost:3020/api/v1/companies/569900-0014" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Om svaret#
status.activeärtrueför bolag som inte är avregistrerade eller upplösta.is_sole_traderärtrueför enskilda firmor.industry.sni_codeär SNI 2007 med fem siffror.- Med
detail=fulltillkommer bland annataddresses,f_tax,vat,business_activity,previous_namesochshare_capital.coveragesäger för varje sektion om något fanns. - Fält som saknas i registret är
null.nullbetyder okänt, inte noll eller nej.
Felkoder#
| Kod | HTTP | Vad du gör |
|---|---|---|
invalid_org_number | 400 | Skicka tio siffror, med eller utan bindestreck, till exempel 569900-0013. |
invalid_parameter | 400 | Kontrollera parametrarna mot endpointens tabell. Okända parametrar avvisas i stället för att ignoreras. |
not_found | 404 | Kontrollera numret. Inte hittat debiteras inte. |
entity_cap_exceeded | 429 | Bolag och personer du redan hämtat i dag går att hämta igen. Behöver du ett högre tak, kontakta support. |
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. |
insufficient_scope | 403 | Skapa en nyckel med rätt scope under Konto → Nycklar. Se scopes. |
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. |
account_not_active | 403 | Använd en testnyckel tills kontot är godkänt. Status syns under Konto. |
blocked_by_phase | 503 | Använd en testnyckel mot sandlådan. Vi meddelar när live-data öppnar. Se sandlådan. |
suspended | 503 | Kontakta support@getbolag.se. |
rate_limited | 429 | Vänta så många sekunder som Retry-After anger och försök igen. Se takt och tak. |
insufficient_credits | 402 | Fyll på under Konto → Krediter. |
monthly_cap_reached | 402 | Höj taket under Konto, eller vänta till nästa månad. |
key_daily_cap_reached | 402 | Höj nyckelns tak under Konto → Nycklar, eller vänta till nästa dygn. |
invalid_idempotency_key | 400 | Skicka ett kort, unikt värde per uppslag, till exempel ett UUID. |
idempotency_key_reused | 422 | Använd en ny nyckel för varje nytt uppslag. Samma nyckel gäller bara när exakt samma anrop görs om. Se Idempotency-Key. |
internal_error | 500 | Försök igen med samma Idempotency-Key. Ange request_id om du kontaktar support. |
Samma uppslag i MCP: verktyget gb_get_company. Se MCP.