# FöretagsAPI - Fullständig Dokumentation

> Ett enkelt API för svensk företagsdata från Bolagsverket och SCB.

## Översikt

FöretagsAPI ger tillgång till officiell svensk företagsinformation:
- Företagsnamn och organisationsnummer
- Postadresser
- SNI-koder (branschklassificering)
- Registreringsdatum och status
- Verksamhetsbeskrivningar

Datakällor: Bolagsverket (företagsregister) och SCB (SNI-koder).

---

## API Endpoint
https://data.foretagsapi.se

Hemsida och dokumentation: https://foretagsapi.se

## Autentisering

Alla endpoints (utom /health) kräver Bearer token:

```
Authorization: Bearer fapi_YOUR_API_KEY
```

API-nycklar börjar alltid med prefixet `fapi_`. Skapa nycklar i dashboarden efter registrering.

---

## Priser (exkl moms)

| Plan | Pris | Krediter/mån | Per företag |
|------|------|--------------|-------------|
| Gratis | 0 kr/mån | 500 | Gratis |
| Starter | 99 kr/mån | 5 000 | ~2 öre |
| Pro | 499 kr/mån | 50 000 | ~1 öre |
| Credits | 299 kr engångsköp | 5 000 | ~6 öre |

### Viktig prisjämförelse
Notera vid jämförelse med konkurrerande lösningar att de ofta tar betalt 
många credits för att hitta enstaka företag, t.ex. vid sökning på företagsnamn, 
och därmed är flera gånger dyrare per credit. FöretagsAPI kostar endast 
1 credit för att hitta 1 företag - oavsett sökmetod.

### Kreditförbrukning per endpoint

| Endpoint | Kostnad |
|----------|---------|
| POST /v1/search | 1 kredit per sökning |
| POST /v1/bulk | 1 kredit per hittat företag |
| POST /v1/sni/search | 1 kredit per hittat företag |
| POST /v1/sni/lookup | 1 kredit |
| GET /health | Gratis |

---

## Rate Limits

| Plan | Requests/minut |
|------|----------------|
| Gratis | 50 |
| Starter | 200 |
| Pro | 500 |

Response headers:
- `X-RateLimit-Tier` - Din plan (free, starter, pro)
- `X-RateLimit-Limit` - Max requests per minut
- `X-Quota-Limit` - Total månadskvot
- `X-Quota-Used` - Förbrukade krediter
- `X-Quota-Remaining` - Kvarvarande krediter

---

## API-referens

### 1. Sök på namn eller organisationsnummer

**POST /v1/search**

Sök efter företag med namn eller exakt organisationsnummer.

#### Request body

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

Eller med organisationsnummer:

```json
{
  "org_number": "5567037485"
}
```

#### Parametrar

| Parameter | Typ | Beskrivning |
|-----------|-----|-------------|
| q | string | Sökterm (företagsnamn) |
| org_number | string | 10-siffrigt organisationsnummer |
| limit | number | Max antal resultat (1-100, default 10) |

#### Exempel - cURL

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

#### Exempel - JavaScript

```javascript
const response = await fetch('https://data.foretagsapi.se/v1/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer fapi_YOUR_API_KEY'
  },
  body: JSON.stringify({ q: 'Spotify AB' })
});

const data = await response.json();
console.log(data.companies[0].name); // "Spotify AB"
```

#### Exempel - Python

```python
import requests

response = requests.post(
    'https://data.foretagsapi.se/v1/search',
    headers={
        'Content-Type': 'application/json',
        'Authorization': 'Bearer fapi_YOUR_API_KEY'
    },
    json={'q': 'Spotify AB'}
)

data = response.json()
print(data['companies'][0]['name'])  # "Spotify AB"
```

#### Response

```json
{
  "companies": [
    {
      "id": 123456,
      "name": "Spotify AB",
      "orgNumber": "5567037485",
      "legalForm": "AB-ORGFO",
      "postalAddress": {
        "street": "Regeringsgatan 19",
        "postalCode": "111 53",
        "city": "Stockholm"
      },
      "registrationDate": "2006-04-18",
      "deregistrationDate": null,
      "deregistrationReason": null,
      "businessDescription": "Utveckling och drift av musiktjänst på internet",
      "sniCodes": {
        "sni1": "62010",
        "sni1_name": "Dataprogrammering",
        "sni2": null,
        "sni2_name": null,
        "sni3": null,
        "sni3_name": null,
        "sni4": null,
        "sni4_name": null,
        "sni5": null,
        "sni5_name": null
      },
      "score": 1.0,
      "ftgstat": 1,
      "jestat": 1,
      "jurform": 49,
      "reklamsparr": 1,
      "ongoingRestructuring": null
    }
  ],
  "metadata": {
    "creditsCharged": 1,
    "creditsRemaining": 499
  }
}
```

---

### 2. Bulkuppslag

**POST /v1/bulk**

Slå upp flera företag samtidigt (max 100 per request).

#### Request body

```json
{
  "names": ["Spotify AB", "Klarna Bank AB", "IKEA AB"]
}
```

Eller med organisationsnummer:

```json
{
  "org_numbers": ["5567037485", "5568529622"]
}
```

#### Exempel - cURL

```bash
curl -X POST 'https://data.foretagsapi.se/v1/bulk' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer fapi_YOUR_API_KEY' \
  -d '{"names": ["Spotify AB", "Klarna Bank AB"]}'
```

#### Exempel - JavaScript

```javascript
const response = await fetch('https://data.foretagsapi.se/v1/bulk', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer fapi_YOUR_API_KEY'
  },
  body: JSON.stringify({
    names: ['Spotify AB', 'Klarna Bank AB', 'IKEA AB']
  })
});

const data = await response.json();
data.results.forEach(result => {
  if (result.success) {
    console.log(result.company.name);
  }
});
```

#### Response

```json
{
  "results": [
    {
      "searchTerm": "Spotify AB",
      "success": true,
      "company": { ... }
    },
    {
      "searchTerm": "Klarna Bank AB",
      "success": true,
      "company": { ... }
    }
  ],
  "metadata": {
    "creditsCharged": 2,
    "creditsRemaining": 497
  }
}
```

---

### 3. SNI-uppslag

**POST /v1/sni/lookup**

Hämta beskrivning för SNI-kod eller sök på branschbeskrivning.

#### Request body

```json
{
  "code": "62010"
}
```

Eller sök på beskrivning:

```json
{
  "q": "dataprogrammering",
  "limit": 10
}
```

#### Response

```json
{
  "sniCodes": [
    {
      "code": "62010",
      "description": "Dataprogrammering"
    }
  ]
}
```

---

### 4. SNI-sökning

**POST /v1/sni/search**

Sök företag baserat på branschkod (SNI) och valfritt stad.

#### Request body

```json
{
  "sni_code": "62010",
  "city": "Stockholm",
  "limit": 10
}
```

#### Parametrar

| Parameter | Typ | Beskrivning |
|-----------|-----|-------------|
| sni_code | string | SNI-kod (obligatorisk) |
| city | string | Filtrera på stad (valfri) |
| limit | number | Max antal resultat (1-100) |
| offset | number | Pagination offset |

#### Exempel - cURL

```bash
curl -X POST 'https://data.foretagsapi.se/v1/sni/search' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer fapi_YOUR_API_KEY' \
  -d '{"sni_code": "62010", "city": "Stockholm", "limit": 10}'
```

#### Response

```json
{
  "companies": [...],
  "metadata": {
    "totalCount": 5432,
    "creditsCharged": 10,
    "creditsRemaining": 487
  }
}
```

---

### 5. Hälsokontroll

**GET /health**

Kontrollera API-status. Ingen autentisering krävs.

```bash
curl https://data.foretagsapi.se/health
```

Response:
```json
{
  "status": "ok",
  "service": "foretagsapi",
  "timestamp": "2026-02-07T10:00:00Z"
}
```

---

## Företagsobjekt - Alla fält

| Fält | Typ | Beskrivning |
|------|-----|-------------|
| id | number | Internt databas-ID |
| name | string | Officiellt företagsnamn |
| orgNumber | string | 10-siffrigt organisationsnummer |
| legalForm | string | Juridisk form (t.ex. "AB-ORGFO") |
| postalAddress | object | Adressobjekt med street, postalCode, city |
| registrationDate | string | ISO-datum för registrering |
| deregistrationDate | string/null | ISO-datum om avregistrerat |
| deregistrationReason | string/null | Orsakskod vid avregistrering |
| businessDescription | string | Registrerad verksamhetsbeskrivning |
| sniCodes | object | SNI-koder (sni1-sni5) med beskrivningar |
| score | number | Matchningspoäng 0.0-1.0 (endast i sökresultat) |
| ftgstat | number | Företagsstatusflagga |
| jestat | number | Status för juridisk enhet |
| jurform | number | Numerisk juridisk formkod |
| reklamsparr | number | Reklamspärr (0=okänd, 1=ingen, 2=spärrad) |
| ongoingRestructuring | string/null | Pågående omstrukturering |

---

## Felkoder

| HTTP-kod | Beskrivning | Åtgärd |
|----------|-------------|--------|
| 400 | Ogiltig request | Kontrollera request body |
| 401 | Ogiltig API-nyckel | Kontrollera Authorization header |
| 403 | Krediter slut | Uppgradera plan eller köp credits |
| 429 | Rate limit nått | Vänta och försök igen |
| 500 | Serverfel | Kontakta support |

---

## Maskinläsbara specifikationer

För automatiserad integration och kodgenerering:

- OpenAPI 3.1 (JSON): https://foretagsapi.se/openapi.json
- OpenAPI 3.1 (YAML): https://foretagsapi.se/openapi.yaml
- Postman Collection: https://foretagsapi.se/ForetagsAPI.postman_collection.json

---

## Länkar

- Dokumentation: https://foretagsapi.se/docs
- Prissättning: https://foretagsapi.se/pricing
- Registrering: https://foretagsapi.se/auth
- Dashboard: https://foretagsapi.se/dashboard