REST-API
Sök bolag
Hitta bolag på namn eller organisationsnummer. Högst tio träffar. Gratis, upp till 1 000 sökningar per dygn.
http
GET /api/v1/companies/search| Operation | Scope | Pris per uppslag |
|---|---|---|
search_companies (sök bolag) | companies:read | Gratis |
Parametrar#
| Namn | Var | Typ | Standard | Beskrivning |
|---|---|---|---|---|
q (krävs) | query | string | – | Namn eller organisationsnummer. Ett namn behöver minst fyra bokstäver eller siffror. Ett nummer slås upp direkt och ger högst en träff. |
limit | query | integer 1–10 | 10 | Antal träffar. Mer än tio går inte; sökningen är till för att hitta rätt bolag, inte för att lista registret. |
only_active | query | boolean | false | true utesluter avregistrerade bolag. |
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.
Sök på namn#
curl -s "http://localhost:3020/api/v1/companies/search?q=exempel&limit=10" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Sök på organisationsnummer#
bash
curl -s "http://localhost:3020/api/v1/companies/search?q=5699000021" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
För kort sökning#
bash
curl -s "http://localhost:3020/api/v1/companies/search?q=ab" \
-H "Authorization: Bearer $GETBOLAG_KEY"Exemplet kunde inte genereras i den här miljön.
Om svaret#
matchärexactnär du sökte på organisationsnummer,normalizednär namnet börjar med det du skrev ochsimilarför övriga träffar.- Sökningen ger aldrig fler än tio träffar och går inte att bläddra i. Den är till för att hitta rätt bolag, inte för att lista registret.
- En enskild firma hittas bara om du söker på dess nummer. Det finns ingen personsökning; ett personnummer som inte är en firma ger inga träffar.
- Sökningen är gratis men har en kvot på 1 000 per konto och dygn. En sökning på organisationsnummer räknas också mot taket för antal olika bolag per dygn.
Felkoder#
| Kod | HTTP | Vad du gör |
|---|---|---|
invalid_query | 400 | Skicka q med ett namn eller ett organisationsnummer. |
query_too_short | 400 | Skriv mer av namnet. |
invalid_parameter | 400 | Kontrollera parametrarna mot endpointens tabell. Okända parametrar avvisas i stället för att ignoreras. |
search_quota_exceeded | 429 | Vänta till nästa dygn, eller slå upp bolag direkt på organisationsnummer. |
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_search_companies. Se MCP.