POST/v1/search

Sök på namn

Sök efter svenska företag på namn.

Översikt

Sök på namn-endpointen låter dig söka efter svenska företag med deras registrerade namn. API:et hittar relevanta resultat även med partiella namn.

Autentisering krävs

Denna endpoint kräver autentisering med en API-nyckel. Registrera ett gratis konto för att komma igång.

Kreditförbrukning

1 kredit per förfrågan (oavsett antal resultat som returneras). En sökning på "Spotify" som returnerar 5 matchande företag förbrukar endast 1 kredit.

Förfrågan

Förfrågningskropp

Skicka ett JSON-objekt med sökfrågan:

json

{
  "q": "Spotify AB",
  "limit": 5
}

Parametrar

Parameter	Typ	Obligatorisk	Beskrivning
q	string	Obligatorisk	Företagsnamnet att söka efter. Stödjer partiella namn.
limit	number	Valfri	Max antal resultat att returnera. Standard: 10, Max: 10.

Kodexempel

Här är exempel på flera programmeringsspråk:

curl

curl -X POST 'https://data.foretagsapi.se/v1/search' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{"q": "Spotify AB"}'

Svar

Lyckat svar (200 OK)

Returnerar ett JSON-objekt som innehåller en array med matchande företag och metadata:

json

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45{
  "companies": [
    {
      "id": 521294,
      "name": "Spotify AB",
      "orgNumber": "5567037485",
      "legalForm": "AB-ORGFO",
      "postalAddress": {
        "street": "Regeringsgatan 19",
        "city": "Stockholm",
        "postalCode": "11153"
      },
      "registrationDate": "2006-04-18",
      "deregistrationDate": null,
      "deregistrationReason": null,
      "businessDescription": "Utveckling av internettjänst...",
      "ongoingRestructuring": null,
      "ftgstat": 1,
      "jestat": 1,
      "jurform": 49,
      "reklamsparr": 0,
      "sniCodes": {
        "sni1": "63100",
        "sni2": "58210",
        "sni3": null,
        "sni4": null,
        "sni5": null,
        "sni1_name": "Databehandling, hosting o.d.",
        "sni2_name": "Utgivning av programvara",
        "sni3_name": null,
        "sni4_name": null,
        "sni5_name": null
      },
      "score": 1.0
    }
  ],
  "metadata": {
    "searchTerm": "Spotify AB",
    "searchType": "name",
    "resultCount": 1,
    "processingTimeMs": 45,
    "timestamp": "2024-01-15T10:30:00Z",
    "mode": "api"
  }
}

Svarsfält

Fält	Typ	Beskrivning
companies	array	Array med matchande företagsobjekt
score	number	Matchningspoäng från 0.0 till 1.0. Högre poäng indikerar bättre matchningar. En poäng på 1.0 betyder en exakt träff.
metadata	object	Metadata om förfrågan inklusive searchTerm, searchType, resultCount, processingTimeMs (behandlingstid i millisekunder), timestamp (ISO 8601-format) och mode

Score-fältet

Fältet score indikerar hur väl företagsnamnet matchar din sökfråga. Använd det för att sortera eller filtrera resultat baserat på relevans.

Företagsobjekt

Varje företag i resultatarrayen innehåller följande fält:

Fält	Typ	Beskrivning
id	number	Internt databas-ID
name	string	Officiellt registrerat företagsnamn
orgNumber	string	10-siffrigt svenskt organisationsnummer (utan bindestreck)
legalForm	string	Juridisk form som textkod. Vanliga värden: AB-ORGFO (Aktiebolag), EF-ORGFO (Enskild firma), HB-ORGFO (Handelsbolag), KB-ORGFO (Kommanditbolag)
postalAddress	object	Adressobjekt med fälten street, city och postalCode
registrationDate	string	ISO-datum för företagsregistrering
deregistrationDate	string \| null	ISO-datum om företaget är avregistrerat, annars null
deregistrationReason	string \| null	Orsakskod vid avregistrering. Vanliga värden: KKAV-AVORG (konkursavslut), FUAV-AVORG (fusion), LIAV-AVORG (likvidation), AKEJH-AVORG (avförd ej registreringspliktig). Null om ej avregistrerat.
businessDescription	string	Företagets registrerade verksamhetsbeskrivning
sniCodes	object	Objekt med sni1-sni5 (5-siffriga SNI-koder) och sni1_name-sni5_name (branschnamn).
score	number	Matchningspoäng 0.0-1.0 (endast sökresultat)
ftgstat	number	F-skattestatus (0=aldrig, 1=aktiv, 9=inaktiv)
jestat	number \| null	Status för juridisk enhet (1=aktiv, null=ej tillgänglig)
jurform	number \| null	Juridisk formkod (numerisk). Vanliga värden: 10=Enskild firma, 31=Handelsbolag, 49=Aktiebolag, 51=Ekonomisk förening. Se även legalForm för textkod.
reklamsparr	number	Reklamspärr (0=okänd, 1=ingen spärr, 2=spärrad)
ongoingRestructuring	string \| null	Kod för pågående avvecklings- eller rekonstruktionsförfarande. Vanliga prefix: LI=likvidation, KK=konkurs, FR=företagsrekonstruktion, FUOL/FUOT=fusion. Formatet är "\|KOD-AVOMFO$datum". Null om inget pågår.

Felsvar

400 Bad Request

Returneras när förfrågningskroppen är ogiltig eller parametern q saknas:

json

{
  "error": "Missing required parameter: q (company name) or org_number"
}

429 Too Many Requests

Returneras när du överskrider hastighetsgränsen för din nivå:

json

{
  "error": "Rate limit exceeded. Please wait and retry."
}