API for uthenting av data

Avkastningsportalen tilbyr et REST-basert API som gir tilgang til avkastningsdata i Avkastningsportalen.

API-et kan benyttes av aktører som ønsker å hente data automatisk til egne løsninger.

Om API-et

• Protokoll: REST
• Dataformat: JSON
• OpenAPI-dokumentasjon: OpenAPI-dokumentasjon

Kom i gang

API-et består av to hovedsteg:

1. Hent tilgjengelige profilgrupper
2. Hent detaljer for ønsket profil

Hente profilgrupper

Profilgrupper inneholder en oversikt over tilgjengelige pensjonsprofiler innen privat- og bedriftsmarkedet.

Privatmarked

GET /api/v5/profilgrupper?marked=PRIVAT
Eksempel: https://avkastningsportalen.no/api/v5/profilgrupper?marked=PRIVAT

Bedriftsmarked

GET /api/v5/profilgrupper?marked=BEDRIFT
Eksempel: https://avkastningsportalen.no/api/v5/profilgrupper?marked=BEDRIFT

Responsen inneholder blant annet:

• Profil-ID
• Leverandør
• Profilnavn
• Produkttyper
• Kategori
• Mål for aksjeandel

Profil-ID benyttes ved videre oppslag på profildetaljer.

Hente profildetaljer

Når du har en profil-ID kan du hente detaljerte data for profilen.

GET /api/v5/profil/{id}
Eksempel: https://avkastningsportalen.no/api/v5/profil/123

Erstatt 123 med ønsket profil-ID.

Hvilke data returneres?

API-et inneholder omfattende informasjon om pensjonsprofilene.

Profilinformasjon

• Profilnavn
• Leverandør
• Produkttyper
• Valuta
• Referanseindeks
• Risikoklasse (SRI/SRRI)
• Aksjeandel
• Obligasjonsandeler
• Valutasikring

Avkastningstall

API-et inneholder historiske avkastningstall, blant annet:

• Månedlige verdier
• Bruttoavkastning
• Nettoavkastning
• Indeks

Risiko og nøkkeltall

For hver profil er det tilgjengelig flere sentrale nøkkeltall:

• Sharpe Ratio
• Information Ratio (IR)
• Volatilitet (36 måneder)
• Volatilitet (60 måneder)
• Relativ volatilitet

Disse kan benyttes til vurdering og sammenligning av pensjonsprofiler.

Eksempel på bruk

Et typisk oppslag i API-et består av følgende steg:

1. Hent profilgrupper for privat- eller bedriftsmarkedet.
2. Finn ønsket profil.
3. Hent detaljert informasjon om profilen.
4. Bruk dataene i egne rapporter, dashboards eller analyser.