API docs - Stellax

Authenticatie

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/vacant_value om een leegwaardeschatting te ontvangen voor elk woonobject in Nederland.

De authenticatiesleutel vindt u in het gedeelte 'Mijn API's' van uw account. De authenticatie gebeurt via de request header (“Api-Secret-Key”: Authenticatiesleutel).

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

{
    "house_number":"48",
    "house_addition":"3",
    "postcode":"1082BX",
    "bag_id":"0363010000879473",
    "sqm":"132",
    "property_type":"Apartment",
    "year":"1961",
   "lot_size":"0"
}

Voorbeeld 2 (geen toevoeging):

{
    "house_number ":"48",
    "house_addition":"",
    "postcode":"1082BX",
    "bag_id":"0363010000879473",
    "sqm":"132"
}

Voorbeeld 3 (geen toevoeging, vierkante meters en BAG id):

{
    "house_number":"48",
    "house_addition":"",
    "postcode":"1082BX"
}

Houd er rekening mee dat de variabelen in stringformaat worden verzonden.

Mogelijke invoerparameters:

Invoer

Parameter

house_number

Positief geheel getal in stringformaat. Kan niet leeg gelaten worden.

house_addition

Cijfer of letter in stringformaat. In het geval dat er geen huistoevoeging, stuur “” zoals in voorbeeld 2 hierboven.

postcode

String in formaat 1234AB, van 1011AA - tot 9999ZZ. Kan niet leeg gelaten worden.

sqm

Positief getal in stringformaat. U kunt dewaardering door toepassing van het aantal vierkante metersuw keuze. Het is geen verplichte invoer en kan worden achtergelatenuit (zoals in Voorbeeld 3).

bag_id

Positief geheel getal in stringformaat. De variabele is eenidentifier van het Kadaster (Verblijfsobject ID). Het is geen verplichte invoer, laat het weg als de BAG-ID onbekend is (zoals in Voorbeeld 3).

property_type

String. Het woningtype uit de lijst: Apartment, Townhouse, Detached, Villa, Bungalow. Niet verplicht.

year

Positief integer. Het bouwjaar van het pand. Niet verplicht.

lot_size

Niet-negatieve float. De grootte van het perceel in vierkante meters. Niet verplicht.

API-antwoordtekst

Voorbeeld:

{
    "score": 6,
    "vacant_value": 680000
}

Uitvoerparameters:

Uitvoer

Beschrijving

score

Geheel getal van 0 tot 7. De score laat zien hoe “zeker” demodel gaat over de schatting. Hoe hoger de score, hoebeter. Indien de schatting wordt gebruikt voor de financiering van eenobject, raden we aan de schattingen te gebruiken meteen score van 5 en hoger.

vacant_value

Leegwaarde geschat door Stellax AVM.

HTTP-antwoord

Code

Beschrijving

Error

200

N/A

400

Foute aanvraag

Een of meer ingangen zijn niet volgens het schema.

422

Validatiefout

Kon geen schatting maken.

Testen

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/test/vacant_value (gratis met de testsleutel) om het juiste formaat van de invoer te testen.

Authenticatie

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/rent om een schatting te ontvangen van de maandelijkse markthuurprijs voor elk woonobject in Nederland.

De authenticatiesleutel vindt u in het gedeelte 'Mijn API's' van uw account. De authenticatie gebeurt via de request header (“Api-Secret-Key”: Authenticatiesleutel).

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

{
    "house_number":"213",
    "house_addition":"3",
    "postcode":"1082 EE",
    "bag_id":"0363010000699525",
    "sqm":"90",
    "year": "2010",
    "property_type": "Townhouse",
    "lot_size": "300"
}

Voorbeeld 2 (minimaal vereiste ingangen worden verzonden):

{
    "house_number ":"6",
    "house_addition":"",
    "postcode":"1081EL"
}

Houd er rekening mee dat de variabelen in stringformaat worden verzonden. Wanneer de extra variabelen naar de server worden verzonden, overschrijven ze de schattingen die zijn gebruikt bij de schatting van de huurprijs.

Mogelijke invoerparameters:

Invoer

Parameter

house_number

Positief geheel getal in stringformaat. Kan niet leeg gelaten worden.

house_addition

Cijfer of letter in stringformaat. In het geval dat er geen huistoevoeging, stuur “” zoals in voorbeeld 2 hierboven.

postcode

String in formaat 1234AB, van 1011AA - tot 9999ZZ. Kan niet leeg gelaten worden.

sqm

Positief getal in stringformaat. Niet verplicht.

bag_id

Positief geheel getal in stringformaat. De variabele is eenidentifier van het Kadaster (Verblijfsobject ID). Niet verplicht.

property_type

String. Het woningtype uit de lijst: Apartment, Townhouse, Detached, Villa, Bungalow. Niet verplicht.

year

Positief integer. Het bouwjaar van het pand. Niet verplicht.

lot_size

Niet-negatieve float. De grootte van het perceel in vierkante meters. Niet verplicht.

API-antwoordtekst

Voorbeeld:

{
    "monthly_rent": 2293,
    "score": 7
}

Uitvoerparameters:

Uitvoer

Beschrijving

monthly_rent

Geheel getal. Een schatting van de maandelijkse markthuur.

score

Geheel getal van 0 tot 7. De score laat zien hoe “zeker” het model is over de schatting. Hoe hoger de score, hoe beter. Indien de schatting wordt gebruikt voor de financiering van een object adviseren wij om de schattingen met een score van 5 en hoger te hanteren.

HTTP-antwoord

Code

Beschrijving

Error

200

N/A

400

Foute aanvraag

Een of meer ingangen zijn niet volgens het schema.

422

Validatiefout

Kon geen schatting maken.

Testen

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/test/rent (gratis met de testsleutel) om het juiste formaat van de invoer te testen.

Authenticatie

Stuur een POST-aanvraag naar https://app.stellax.ai/api/public/wws_points en ontvang een indicatie van de WWS-punten voor ieder woonobject in Nederland (zelfstandige woningen).

De authenticatiesleutel vindt u in het gedeelte 'Mijn API's' van uw account. De authenticatie gebeurt via de request header (“Api-Secret-Key”: Authenticatiesleutel).

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

{
    "house_number":"213",
    "house_addition":"3",
    "postcode":"1082EE",
    "bag_id":"0363010000699525",
    "property_type":"Apartment",
    "sqm":"200",
    "sqm_extra_joint":"10",
    "sqm_extra_inside":"10",
    "sqm_extra_outside":"20",
    "balcony":"1",
    "garden":"1",
    "sqm_garden":"40",
    "floors":"2",
    "woz_value":"50000",
    "bedrooms":"3",
    "energy_label":"A+",
    "year":"2010",
    "lot_size":"500"
}

Voorbeeld 2 (minimaal vereiste invoer wordt verzonden):

{
    "house_number ":"6",
    "house_addition":"",
    "postcode":"1081EL"
}

Mogelijke invoerparameters:

Invoer

Parameter

house_number

Positief geheel getal in stringformaat. Kan niet leeg gelaten worden.

house_addition

Cijfer of letter in stringformaat. In het geval dat er geen huistoevoeging, stuur “” zoals in voorbeeld 2 hierboven.

postcode

String in formaat 1234AB, van 1011AA - tot 9999ZZ. Kan niet leeg gelaten worden.

sqm

Positief getal in stringformaat. Niet verplicht.

bag_id

Positief geheel getal in stringformaat. De variabele is een identifier van het Kadaster (Verblijfsobject ID). Niet verplicht.

property_type

String. Het woningtype uit de lijst: Apartment, Townhouse, Detached, Villa, Bungalow. Niet verplicht.

sqm_extra_joint

Niet-negatief geheel getal. Extra oppervlakte (voeg) is een maatstaf voor de extra oppervlakte van de constructie die grenst aan het hoofdgebouw. Niet verplicht.

sqm_extra_inside

Niet-negatief geheel getal. Extra oppervlakte (binnen) is een maatstaf voor de extra oppervlakte binnen het pand naast de woonoppervlakte. Niet verplicht.

sqm_extra_outside

Niet-negatief geheel getal. Extra oppervlakte (buiten) is een maatstaf voor de extra oppervlakte van het bouwwerk die niet het hoofdgebouw is of grenst aan het hoofdgebouw. Niet verplicht.

balcony

1 als de woning een balkon heeft en 0 als dit niet het geval is. Niet verplicht.

garden

1 als de woning een tuin heeft en 0 als deze niet aanwezig is. Niet verplicht.

sqm_garden

Niet-negatief geheel getal. De tuinoppervlakte in vierkante meters. Niet verplicht.

floors

Niet-negatief geheel getal. Het aantal verdiepingen. Niet verplicht.

woz_value

Niet-negatieve float. Schatting van de WOZ-waarde van de woning. Niet verplicht.

bedrooms

Niet-negatief geheel getal. Het aantal slaapkamers. Niet verplicht.

energy_label

String. Het energielabel. Niet verplicht.

year

Positief integer. Het bouwjaar van het pand. Niet verplicht.

lot_size

Niet-negatieve float. De grootte van het perceel in vierkante meters. Niet verplicht.

API-antwoordtekst

Voorbeeld:

{   
   "energieprestatie": -10,
    "gemeenschappelijke_ruimten": 0, 
    "keuken": 7,
    "oppervlakte_overige_ruimten": 5,
    "oppervlakte_van_vertrekken": 70,
    "prive_buitenruimten": 3,
    "renovatie": 0,
    "rijksmonument": 0,
    "sanitair": 8,
    "total": 147,
    "verwarming": 11,
    "woonvoorzieningen_gehandicapten": 0,
    "woz_correctie": 0,
    "woz_waarde": 53,
    "wws_huur": 905,
    "zorgwoning": 0
}

Uitvoerparameters:

Uitvoer

Beschrijving

total

Geheel getal. Het totaal aantal WWS-punten.

wws_huur

Geheel getal. Het huurbedrag op basis van de WWS-punten.

energieprestatie

Geheel getal. Het aantal punten voor de energie-efficiëntie.

gemeenschappelijke_ruimten

Geheel getal. Het aantal punten voor de gemeenschappelijke ruimtes.

keuken

Geheel getal. Het aantal punten voor de keuken.

oppervlakte_overige_ruimten

Geheel getal. Het aantal punten voor de niet-woonruimte.

oppervlakte_van_vertrekken

Geheel getal. Het aantal punten voor de woonruimte.

prive_buitenruimten

Geheel getal. Het aantal punten voor de privé buitenruimte.

renovatie

Geheel getal. Het aantal punten voor investeringen in de renovatie.

rijksmonument

Geheel getal. Het aantal punten voor de status “rijksmonument”.

sanitair

Geheel getal. Het aantal punten voor de badkamer/toilet etc.

verwarming

Geheel getal. Het aantal punten voor de verwarming.

woonvoorzieningen_gehandicapten

Geheel getal. Het aantal punten voor de huisvestingsvoorzieningen voor gehandicapten.

woz_correctie

Geheel getal. Correctie op de woz_waardepunten vanwege het puntenplafond.

woz_waarde

Geheel getal. Het aantal punten voor de WOZ-waarde.

zorgwoning

Geheel getal. Het aantal punten voor de status “zorgwoning”.

HTTP-antwoord

Code

Beschrijving

Error

200

N/A

400

Foute aanvraag

Een of meer ingangen zijn niet volgens het schema.

422

Validatiefout

Kon geen schatting maken.

Testen

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/test/wws_points (gratis met de testsleutel) om het juiste formaat van de invoer te testen.

Authenticatie

Stuur een POST-verzoek naar https:/app.stellax.ai/api/public/market_intelligence om marktanalyses voor het interessegebied te ontvangen.

De authenticatiesleutel vindt u in het gedeelte 'Mijn API's' van uw account. De authenticatie gebeurt via de request header (“Api-Secret-Key”: Authenticatiesleutel).

Hoofdtekst van API-verzoek

Voorbeeld 1 (land):

{
    "Place":"Netherlands"
}

Voorbeeld 2 (stad):

{
    "Place":"Amsterdam"
}

Voorbeeld 3 (postcode):

{
    "Place":"1082"
}

Houd er rekening mee dat de variabelen in stringformaat worden verzonden.

Mogelijke invoerparameters:

Invoer

Parameter

Plaats

String met het interessegebied. Stuur 'Nederland' om de analyses op landniveau te ontvangen (voorbeeld 1). Stuur anders de plaatsnaam of de 4 cijfers van de gewenste postcode (voorbeeld 2 en 3). Kan niet leeg gelaten worden.

API-antwoordtekst

Voorbeeld:

{
    "days_to_rent": 16,
    "days_to_sell": 28,
    "gross_yield": 4.64,
    "index_price_dynamics": "100,98.3,96.6,95.0,
        93.3,91.6,90.2,
        89.1,88.7,88.9,89.7,
        90.1,90.8",
    "index_rent_dynamics": "100,101.2,102.0,
        102.3,102.3,102.2,
        102.3,102.5,102.9,
        103.3,103.8,104.5,105.4",
    "monthly_rent": 2100,
    "net_yield": 3.44,
    "periods_price": "June_2022,July_2022,August_2022,
        September_2022,October_2022,November_2022,
        December_2022,January_2023,February_2023,
        March_2023,April_2023,May_2023,June_2023",
    "periods_rent": "June_2022,July_2022,August_2022,
        September_2022,October_2022,November_2022,
        December_2022,January_2023,February_2023,
        March_2023,April_2023,May_2023,June_2023",
    "periods_yield": "June_2022,July_2022,August_2022,
        September_2022,October_2022,November_2022,
        December_2022,January_2023,February_2023,
        March_2023,April_2023,May_2023,June_2023",
    "price": 526000,
    "price_per_sqm": 7105,
    "rent_per_sqm": 27,
    "sqm_rented": 80,
    "sqm_sold": 70,
    "stellax_risk_score": 86,
    "yield_dynamics": "3.96,4.08,4.19,4.28,4.36,4.44,
        4.52,4.59,4.63,
        4.64,4.62,4.62,4.63"
}

Uitvoerparameters:

Uitvoer

Beschrijving

days_to_rent

Geheel getal. Het gemiddelde aantal dagen om een woning te verkopen.

days_to_sell

Leegwaarde geschat door Stellax AVM.

gross_yield

Float. Het gemiddelde brutorendement.

index_price_dynamics

String (door komma's gescheiden waarden). De aankoopprijsdynamiekindex (met de eerste maand = 100).

index_rent_dynamics

String (door komma's gescheiden waarden). De huurdynamiekindex (met de eerste maand = 100).

yield_dynamics

String (door komma's gescheiden waarden). De dynamiek van het brutorendement.

monthly_rent

Geheel getal. De gemiddelde maandhuur.

net_yield

Float. Het gemiddelde nettorendement.

periods_price

String (door komma's gescheiden waarden). De overeenkomstige perioden van de index van de aankoopprijsdynamiek.

periods_rent

String (door komma's gescheiden waarden). De overeenkomstige perioden van de huurdynamiekindex.

periods_yield

String (door komma's gescheiden waarden). De overeenkomstige perioden van de rendementsdynamiek.

price

Geheel getal. De gemiddelde aankoopprijs.

price_per_sqm

Geheel getal. De gemiddelde aankoopprijs per vierkante meter.

rent_per_sqm

Geheel getal. De gemiddelde maandhuur per vierkante meter.

sqm_rented

Geheel getal. De gemiddelde vierkante meter van een verhuurd pand.

sqm_sold

Geheel getal. De gemiddelde vierkante meter van een verkocht pand.

stellax_risk_score

Geheel getal. De mediaanwaarde van de Stellax Risk Score. Stellax Risk Score is een eigen Stellax-risicomaatstaf, die de risicograad van beleggingen beoordeelt. De score varieert van 1 (hoogste risico) tot 99 (laagste risico).

HTTP-antwoord

Code

Beschrijving

Error

200

N/A

400

Foute aanvraag

Een of meer ingangen zijn niet volgens het schema.

422

Validatiefout

Kon geen schatting maken.

Testen

Stuur een POST-verzoek naar https://app.stellax.ai/api/public/test/market_intelligence (gratis met de testsleutel) om het juiste formaat van de invoer te testen.

API documentatie

Authenticatie

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

Voorbeeld 2 (geen toevoeging):

Voorbeeld 3 (geen toevoeging, vierkante meters en BAG id):

Mogelijke invoerparameters:

API-antwoordtekst

Voorbeeld:

Uitvoerparameters:

HTTP-antwoord

Testen

Authenticatie

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

Voorbeeld 2 (minimaal vereiste ingangen worden verzonden):

Mogelijke invoerparameters:

API-antwoordtekst

Voorbeeld:

Uitvoerparameters:

HTTP-antwoord

Testen

Authenticatie

Hoofdtekst van API-verzoek

Voorbeeld 1 (alle ingangen worden verzonden):

Voorbeeld 2 (minimaal vereiste invoer wordt verzonden):

Mogelijke invoerparameters:

API-antwoordtekst

Voorbeeld:

Uitvoerparameters:

HTTP-antwoord

Testen

Authenticatie

Hoofdtekst van API-verzoek

Voorbeeld 1 (land):

Voorbeeld 2 (stad):

Voorbeeld 3 (postcode):

Mogelijke invoerparameters:

API-antwoordtekst

Voorbeeld:

Uitvoerparameters:

HTTP-antwoord

Testen

Stellax

Oplossingen

Documenten