Fetch key word analysis for a given property
POST/listings/key-word-analysis
Keyword Analysis Endpoint
Overview
This API returns weather or not a certain keyword exists in a properties listing. You can query by either Batch ID or FINN Code or Property ID NMA or Housing Association ID NMA.
You can also provide a list of keywords to get specific keywords in the response.
The data returned can be used to find very specific characteristics of a property, such as if it has a jacuzzi, a swimming pool, or a furnitured basement.
It supports both single property retrieval and batch downloads.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
batch-id | integer | No | Unique identifier for the batch of records. |
property-id-nma | integer | No | Unique identifier for the property, generated by PropCloud based on: city number, ground number, usage number, lease number and section number |
housing-association-id-nma | integer | No | Unique identifier for the housing association unit, formatted as organization number-share number, i.e. "924758716-4" |
list-of-keywords | integer | No | A listing containing boolean value of weather or not that key word exists in the listing |
start-date | string | No | The start date for the date range. Format: YYYY-MM-DD. |
end-date | string | No | The end date for the date range. Format: YYYY-MM-DD. |
Headers
| Header | Value |
|---|---|
accept | application/json |
api-key | YOUR_API_KEY |
Example Request
curl -X 'POST' \
'https://apis.propcloud.no/api/public/listings/key-word-analysis' \
-H 'accept: application/json' \
-H 'api-key: your api key' \
-H 'Content-Type: application/json' \
-d '{
"property-id-nma": "0301-229-10-0-0"
}'
Response Description
| Key | Description | Beskrivelse | Source |
|---|---|---|---|
totalPages | The total number of pages of response for this specific query. | Totalt antall sider med respons for denne spesifikke forespørselen. | PropCloud |
batchId | Unique identifier for the batch of records. | Unik identifikator for batchen med poster. | PropCloud |
finnCode | This code is used to identify ads in FINN | Kode brukt for aa identifisere annonsen | Finn.no |
propertyIdNma | Unique identifier for the property, generated by PropCloud based on: city number, ground number, usage number, lease number and section number | Unik identifikator for eiendommen generert av PropCloud basert paa: kommunenummer, gaardsnummer, bruksnummer, festenummer og seksjonsnummer | PropCloud |
housingAssociationIdNma | Unique identifier for the housing association unit, formatted as organization number-share number, i.e. "924758716-4" | Unik identifikator for borettslagsandelen, formatert som organisasjonsnummer-andelsnummer, i.e. "924758716-4" | PropCloud |
address | The physical address of the property. | Eiendommens fysiske adresse. | Finn.no |
adtype | The type of listing (e.g., sale, rental). | Type oppforing (f.eks. salg, utleie). | Finn.no |
listingDate | The date when the property was listed or last updated. | Datoen da eiendommen ble lagt ut eller sist oppdatert. | Finn.no |
hybel | Weather or not HYBEL key word exists | Finnes HYBEL nokkelordet? | PropCloud |
utleie | Weather or not UTLEIE key word exists | Finnes UTLEIE nokkelordet? | PropCloud |
praktikant | Weather or not PRAKTIKANT key word exists | Finnes PRAKTIKANT nokkelordet? | PropCloud |
boenhet | Weather or not BOENHET key word exists | Finnes BOENHET nokkelordet? | PropCloud |
leieinntekt | Weather or not LEIEINNTEKT key word exists | Finnes LEIEINNTEKT nokkelordet? | PropCloud |
utleieenheten | Weather or not UTLEIEENHETEN key word exists | Finnes UTLEIEENHETEN nokkelordet? | PropCloud |
utleiedelen | Weather or not UTLEIEDELEN key word exists | Finnes UTLEIEDELEN nokkelordet? | PropCloud |
sokkel | Weather or not SOKKEL key word exists | Finnes SOKKEL nokkelordet? | PropCloud |
separatInngang | Weather or not SEPARAT INNGANG key word exists | Finnes SEPARAT INNGANG nokkelordet? | PropCloud |
egenInngang | Weather or not EGEN INNGANG key word exists | Finnes EGEN INNGANG nokkelordet? | PropCloud |
utleieleilighet | Weather or not UTLEIELEILIGHET key word exists | Finnes UTLEIELEILIGHET nokkelordet? | PropCloud |
utleiebolig | Weather or not UTLEIEBOLIG key word exists | Finnes UTLEIEBOLIG nokkelordet? | PropCloud |
utleiemulighet | Weather or not UTLEIEMULIGHET key word exists | Finnes UTLEIEMULIGHET nokkelordet? | PropCloud |
muligheterForUtleie | Weather or not MULIGHETER FOR UTLEIE key word exists | Finnes MULIGHETER FOR UTLEIE nokkelordet? | PropCloud |
mulighetForUtleie | Weather or not MULIGHET FOR UTLEIE key word exists | Finnes MULIGHET FOR UTLEIE nokkelordet? | PropCloud |
medUtleie | Weather or not MED UTLEIE key word exists | Finnes MED UTLEIE nokkelordet? | PropCloud |
mUtleie | Weather or not M/UTLEIE key word exists | Finnes M/UTLEIE nokkelordet? | PropCloud |
kjeller | Weather or not KJELLER key word exists | Finnes KJELLER nokkelordet? | PropCloud |
arkitekttegnet | Weather or not ARKITEKTTEGNET key word exists | Finnes ARKITEKTTEGNET nokkelordet? | PropCloud |
arkitekt | Weather or not ARKITEKT key word exists | Finnes ARKITEKT nokkelordet? | PropCloud |
takterrasse | Weather or not TAKTERRASSE key word exists | Finnes TAKTERRASSE nokkelordet? | PropCloud |
svommebasseng | Weather or not SVOMMEBASSENG key word exists | Finnes SVOMMEBASSENG nokkelordet? | PropCloud |
pakostet | Weather or not PÅKOSTET key word exists | Finnes PÅKOSTET nokkelordet? | PropCloud |
jacuzzi | Weather or not JACUZZI key word exists | Finnes JACUZZI nokkelordet? | PropCloud |
boblebad | Weather or not BOBLEBAD key word exists | Finnes BOBLEBAD nokkelordet? | PropCloud |
tg3 | Weather or not TG3 key word exists | Finnes TG3 nokkelordet? | PropCloud |
vannskade | Weather or not VANNSKADE key word exists | Finnes VANNSKADE nokkelordet? | PropCloud |
parkeringskjeller | Weather or not PARKERINGSKJELLER key word exists | Finnes PARKERINGSKJELLER nokkelordet? | PropCloud |
garasjekjeller | Weather or not GARASJEKJELLER key word exists | Finnes GARASJEKJELLER nokkelordet? | PropCloud |
garasjeanlegg | Weather or not GARASJEANLEGG key word exists | Finnes GARASJEANLEGG nokkelordet? | PropCloud |
parkeringsannlegg | Weather or not PARKERINGSANNLEGG key word exists | Finnes PARKERINGSANLEGG nokkelordet? | PropCloud |
parkeringsanlegg | Weather or not PARKERINGSANLEGG key word exists | Finnes PARKERINGSANLEGG nokkelordet? | PropCloud |
oppussing | Weather or not OPPUSSING key word exists | Finnes OPPUSSING nokkelordet? | PropCloud |
innlagtVann | Weather or not INNLAGT VANN key word exists | Finnes INNLAGT VANN nokkelordet? | PropCloud |
innlagtStrom | Weather or not INNLAGT STROM key word exists | Finnes INNLAGT STROM nokkelordet? | PropCloud |
flattTak | Weather or not FLATT TAK key word exists | Finnes FLATT TAK nokkelordet? | PropCloud |
oppussingsobjekt | Weather or not OPPUSSINGSOBJEKT key word exists | Finnes OPPUSSINGSOBJEKT nokkelordet? | PropCloud |
renoveringsobjekt | Weather or not RENOVERINGSOBJEKT key word exists | Finnes RENOVERINGSOBJEKT nokkelordet? | PropCloud |
utsikt | Weather or not UTSIKT key word exists | Finnes UTSIKT nokkelordet? | PropCloud |
solrik | Weather or not SOLRIK key word exists | Finnes SOLRIK nokkelordet? | PropCloud |
solforhold | Weather or not SOLFORHOLD key word exists | Finnes SOLFORHOLD nokkelordet? | PropCloud |
kveldssol | Weather or not KVELDSSOL key word exists | Finnes KVELDSSOL nokkelordet? | PropCloud |
vestvendt | Weather or not VESTVENDT key word exists | Finnes VESTVENDT nokkelordet? | PropCloud |
godStandard | Weather or not GOD STANDARD key word exists | Finnes GOD STANDARD nokkelordet? | PropCloud |
hoyStandard | Weather or not HOY STANDARD key word exists | Finnes HOY STANDARD nokkelordet? | PropCloud |
enkelStandard | Weather or not ENKEL STANDARD key word exists | Finnes ENKEL STANDARD nokkelordet? | PropCloud |
lekker | Weather or not LEKKER key word exists | Finnes LEKKER nokkelordet? | PropCloud |
delikat | Weather or not DELIKAT key word exists | Finnes DELIKAT nokkelordet? | PropCloud |
fantastisk | Weather or not FANTASTISK key word exists | Finnes FANTASTISK nokkelordet? | PropCloud |
velholdt | Weather or not VELHOLDT key word exists | Finnes VELHOLDT nokkelordet? | PropCloud |
moderne | Weather or not MODERNE key word exists | Finnes MODERNE nokkelordet? | PropCloud |
pussetOpp | Weather or not PUSSET OPP key word exists | Finnes PUSSET OPP nokkelordet? | PropCloud |
oppusset | Weather or not OPPUSSET key word exists | Finnes OPPUSSET nokkelordet? | PropCloud |
renovert | Weather or not RENOVERT key word exists | Finnes RENOVERT nokkelordet? | PropCloud |
oppgradert | Weather or not OPPGRADERT key word exists | Finnes OPPGRADERT nokkelordet? | PropCloud |
utbedret | Weather or not UTBEDRET key word exists | Finnes UTBEDRET nokkelordet? | PropCloud |
rehabilitert | Weather or not REHABILITERT key word exists | Finnes REHABILITERT nokkelordet? | PropCloud |
landlig | Weather or not LANDLIG key word exists | Finnes LANDLIG nokkelordet? | PropCloud |
sentral | Weather or not SENTRAL key word exists | Finnes SENTRAL nokkelordet? | PropCloud |
attraktiv | Weather or not ATTRAKTIV key word exists | Finnes ATTRAKTIV nokkelordet? | PropCloud |
rolig | Weather or not ROLIG key word exists | Finnes ROLIG nokkelordet? | PropCloud |
paregnes | Weather or not PÅREGNES key word exists | Finnes PÅREGNES nokkelordet? | PropCloud |
oppgradering | Weather or not OPPGRADERING key word exists | Finnes OPPGRADERING nokkelordet? | PropCloud |
renovering | Weather or not RENOVERING key word exists | Finnes RENOVERING nokkelordet? | PropCloud |
rehabilitering | Weather or not REHABILITERING key word exists | Finnes REHABILITERING nokkelordet? | PropCloud |
modernisering | Weather or not MODERNISERING key word exists | Finnes MODERNISERING nokkelordet? | PropCloud |
behov | Weather or not BEHOV key word exists | Finnes BEHOV nokkelordet? | PropCloud |
slitasje | Weather or not SLITASJE key word exists | Finnes SLITASJE nokkelordet? | PropCloud |
skader | Weather or not SKADER key word exists | Finnes SKADER nokkelordet? | PropCloud |
fukt | Weather or not FUKT key word exists | Finnes FUKT nokkelordet? | PropCloud |
mugg | Weather or not MUGG key word exists | Finnes MUGG nokkelordet? | PropCloud |
sopp | Weather or not SOPP key word exists | Finnes SOPP nokkelordet? | PropCloud |
laminat | Weather or not LAMINAT key word exists | Finnes LAMINAT nokkelordet? | PropCloud |
tapet | Weather or not TAPET key word exists | Finnes TAPET nokkelordet? | PrCloud |
takess | Weather or not TAKESS key word exists | Finnes TAKESS nokkelordet? | PropCloud |
takEss | Weather or not TAK-ESS key word exists | Finnes TAK-ESS nokkelordet? | PropCloud |
parkett | Weather or not PARKETT key word exists | Finnes PARKETT nokkelordet? | PropCloud |
flis | Weather or not FLIS key word exists | Finnes FLIS nokkelordet? | PropCloud |
tek10 | Weather or not TEK-10 key word exists | Finnes TEK-10 nokkelordet? | PropCloud |
tek17 | Weather or not TEK-17 key word exists | Finnes TEK-17 nokkelordet? | PropCloud |
utleietittel | Weather or not UTLEIETITTEL key word exists | Finnes UTLEIETITTEL nokkelordet? | PropCloud |
kjellerord | True if any of the following phrases are found in either the description or the heading: "under bakkeplan", "kjeller", "underetasje", "kjellerstue", "kjellerrom", "vinkjeller", "kjellerleilighet", or "sokkel". Otherwise, False. | Sann hvis en av følgende fraser finnes i enten beskrivelsen eller overskriften: "under bakkeplan", "kjeller", "underetasje", "kjellerstue", "kjellerrom", "vinkjeller", "kjellerleilighet" eller "sokkel". Ellers usann. | PropCloud |
oppussing | True if any of the following phrases are found in either the description or the heading: "rennovering", "oppussing", "rehabilitering", or "oppgraderingsbehov". Otherwise, False. | Sann hvis en av følgende fraser finnes i enten beskrivelsen eller overskriften: "rennovering", "oppussing", "rehabilitering" eller "oppgraderingsbehov". Ellers usann. | PropCloud |
standardTekst | True if any of the following phrases are found in either the description or the heading: "ingen separat utleie", "ingen utleie", "ingen egen utleie", "ingen egen utleiedel", "kun en bruksenhet", "kun én bruksenhet", "boligen kan leies ut i sin helhet", "styret er utleie", "adgang til utleie", "salg og utleie av fast", "hele eiendommen leies", or "hele boligen kan leies ut". Otherwise, False. | Sann hvis en av følgende fraser finnes i enten beskrivelsen eller overskriften: "ingen separat utleie", "ingen utleie", "ingen egen utleie", "ingen egen utleiedel", "kun en bruksenhet", "kun én bruksenhet", "boligen kan leies ut i sin helhet", "styret er utleie", "adgang til utleie", "salg og utleie av fast", "hele eiendommen leies" eller "hele boligen kan leies ut". Ellers usann. | PropCloud |
Request
Responses
- 200
- 422
Successful Response
Validation Error