REST-API
REST-API
Bas-URL, endpoints, operationer och priser i REST-API:t v1.
Bas-URL: http://localhost:3020/api/v1. Alla anrop är GET, tar en nyckel i Authorization och svarar med JSON. Versionen står i sökvägen; ändringar som bryter bakåtkompatibiliteten kommer bara i en ny version, se changelog.
| Endpoint | Operation | Scope | Pris |
|---|---|---|---|
GET /api/v1/companies/search | search_companies | companies:read | Gratis |
GET /api/v1/companies/{org_number} | get_company | companies:read | 0,05 kr |
GET /api/v1/companies/{org_number} | get_company_full | companies:read | 0,10 kr |
GET /api/v1/companies/{org_number}/roles | get_company_roles | roles:read | 0,10 kr |
GET /api/v1/companies/{org_number}/history | get_company_history | history:read | 0,50 kr |
GET /api/v1/companies/{org_number}/financials | get_financials | financials:read | 0,10 kr |
GET /api/v1/persons/{person_ref}/engagements | get_person_engagements | persons:read | 0,10 kr |
GET /api/v1/account | – | – | Gratis |
Gemensamt för alla anrop#
- Svaret är
{ "status": "ok", "data", "meta" }eller{ "status": "error", "error": { "code", "message" } }. Se svarsformat och felkoder. - Organisationsnummer tas emot med eller utan bindestreck och returneras som
NNNNNN-NNNN. - Skicka
Idempotency-Keynär du försöker igen efter ett nätverksfel, så debiteras samma uppslag inte två gånger. Se takt och tak. - Svaren cachas inte (
Cache-Control: no-store). - OpenAPI 3: http://localhost:3020/openapi.json.
Endpoints#
Sök bolag
Hitta bolag på namn eller organisationsnummer. Högst tio träffar. Gratis, upp till 1 000 sökningar per dygn.
Hämta bolag
Bolagsprofil: namn, form, status, säte och bransch. Med detail=full även adresser, F-skatt, moms, verksamhet, tidigare namn och aktiekapital.
Styrelse och roller
Styrelse, VD, suppleanter och revisor med person_ref, och bolagets firmateckning.
Historik och ändringar
Registrerade ändringar (styrelse, adress, årsredovisning med mera) sedan ett datum, och bolagets statushistorik.
Bokslut och nyckeltal
Resultat- och balansräkning i tusental kronor och nyckeltal för upp till fem år. Bara aktiebolag.
Personers engagemang
Alla bolag där en person har eller har haft ett uppdrag. Personen anges med person_ref från ett rollsvar.
Konto och saldo
Ditt konto, saldot, månadens förbrukning och nyckelns scopes och miljö. Gratis och mäts inte.