Gå til indhold

Svar, fejl og kvote

Svarformat

Et vellykket kald svarer med status og data:

{ "status": "success", "data": { } }

En fejl har fejlens HTTP-status og denne krop:

{ "status": "error", "error": { "code": 403, "message": "insufficient_scope: this endpoint requires the scope 'properties'" } }

Tilføj ?pretty=1 til et kald for at få svaret pænt opstillet.

Jeres licens bestemmer, hvad I ser

Scopet afgør, om du kan kalde et endpoint. Din licens (Gratis, All insights eller Premium) afgør, hvor meget af svaret du får.

  • Felter, din licens ikke omfatter, er null, og objektet, de ligger i, nævner dem i restricted, fx "restricted": ["tinglysning", "access_holders"]. Et null-felt, der ikke står dér, er reelt tomt.
  • Felter og filtre, der kræver Premium, er mærket (Premium) i referencen.
  • Segmentfiltre, din licens ikke omfatter, bliver ignoreret, så count kun afspejler de filtre, du har adgang til. Bliver alle filtre ignoreret, er svaret 400 No filters supplied.
  • Reelle ejere kræver desuden beneficial_purpose og beneficial_accept=1. Se Formål for opslag på reelle ejere.

Licensen kan skifte uden nyt token: efter en op- eller nedgradering giver næste kald de nye felter.

Fejlkoder

Status Betydning
400 Ugyldigt input, fx en ukendt parameter på et segment-endpoint eller en søgning på under 3 tegn
401 Access token mangler, er ugyldigt eller udløbet
402 Betaling eller kapacitet mangler: et ubetalt segment, ingen leadkapacitet, eller Ajour uden licens eller købt Ajour. Kroppen linker til, hvor I kan købe
403 Tokenet har ikke det scope, endpointet kræver
404 Findes ikke. Data, der tilhører en anden virksomhed, giver også 404
409 Konflikt, fx at emnet allerede er på listen
429 Kvoten eller timegrænsen er nået

Et 429-svar har headeren Retry-After (sekunder) og fortæller i error.message, om det er kvoten eller timegrænsen. Er det kvoten, linker error.upgrade_url til, hvor I skifter API-niveau.

Lister og sider

Svar med sider har items, count, page, pageCount, nextPageUrl og prevPageUrl. Brug page til at bladre.

  • Søgning (/…/search) er til at finde ét bestemt emne, ikke til at trække lister ud. q skal være 3 til 100 tegn, limit 1 til 10 resultater pr. side, og en søgning har højst 10 sider.
  • Filteropslag (/…/segments) giver det samlede count og op til 3 eksempler.
  • Hele lister kommer fra et købt segment: køb det i ownr, og hent det med GET /segments/downloads/{id}, 20 rækker pr. side. Se guiden til segmenter.

Id’er og henvisninger

Emne Id
Virksomhed CVR-nummer
P-enhed P-nummer
Erhvervsperson ownr’s person-id
Ejendom DAF-id (tekst)
Årsrapport Rapport-id

Alle henvisninger til et andet emne bruger samme item-objekt: {"id", "slug", "url", "name"}. url er API-stien, du henter emnet med.

Kvote og grænser

Virksomheden har én kvote, som alle dens nøgler deler.

  • Gratis: 1.000 kald om måneden, regnet fra den dag API-adgangen blev slået til.
  • Købt API-niveau: fra 5.000 til 1.000.000 kald om måneden. Kvoten nulstilles hver måned på betalingsdagen, også ved årlig betaling. En administrator køber eller skifter niveau under API Adgang, og en opgradering gælder med det samme. Se priser.
Kald
Tæller i kvoten Vellykkede kald (2xx) til data-endpoints: /company, /p-unit, /report, /person, /property, filteropslag på segmenter og /beneficial-owners/purposes. Kald via MCP til disse endpoints tæller på samme måde
Tæller ikke Fejl (4xx, 5xx, 429), /token, /pipelines…, Følg, Ajour, /account/…, /segments/downloads… og webhook-leveringer

Når kvoten er brugt op, svarer de endpoints, der tæller, 429, indtil kvoten nulstilles. De øvrige virker stadig. Virksomhedens administratorer får en e-mail ved 80 % og 100 % af kvoten.

Der er også en timegrænse, som alle kald tæller med i: 300 kald i timen på det gratis niveau og 1.000 til 60.000 på de købte. Der er ingen grænse pr. sekund.

Headers

Header Indhold
X-Quota-Limit Kald i den aktuelle kvoteperiode
X-Quota-Remaining Kald tilbage i kvoteperioden
X-Quota-Reset Hvornår kvoten nulstilles (ISO 8601)
X-RateLimit-Limit Tilladte kald i den aktuelle time
X-RateLimit-Remaining Kald tilbage i den aktuelle time
X-RateLimit-Reset Sekunder til timegrænsen nulstilles

Kvote-headerne sendes af de endpoints, der tæller i kvoten. Time-headerne er med i alle svar.

Hvor friske er data?

ownr henter data fra de offentlige registre (CVR, BBR, Tinglysning, Statstidende og årsrapporter) i kørsler. Svarene er så friske som den seneste kørsel, ikke i realtid.