estate-portal-aggregator
v1.8.1
Published
This module helps fetching real estate data from immobilienscout24 and flowfact.
Downloads
41
Maintainers
Readme
estate-portal-aggregator
This module helps to fetch and normalize real estate data from immobilienscout24 and/or flowfact.
CLI
Every command has a
--help
flag that can be used to get more information about flags and arguments of the command
generate-dictionary
Use this command to create a json file that includes all translation keys for the normalized real estate data properties.
estate-portal generate-dictionary --help
Immobilienscout24
generate-dictionary
Use this command to create a json file that includes all translation keys for the normalized Immobilienscout24 real estate data.
estate-portal immobilienscout24 generate-dictionary --help
fetch-estates
Use this command to fetch all estates in a detailed or short version.
estate-portal immobilienscout24 fetch-estates --help
fetch-estate
Use this command to fetch a single estate in a detailed version.
estate-portal immobilienscout24 fetch-estate --help
FlowFact
generate-dictionary
Use this command to create a json file that includes all translation keys for the normalized FlowFact real estate data.
estate-portal flowfact generate-dictionary --help
fetch-estates
Use this command to fetch all estates in a detailed or short version.
estate-portal flowfact fetch-estates --help
fetch-estate
Use this command to fetch a single estate in a detailed version.
estate-portal flowfact fetch-estate --help
Usage as a module
Following (typed) classes are exported:
- Immobilienscout24
- FlowFactV1
- FlowFactV2
Following (typed) helper functions are exported:
- generateCommonPropertiesDictionary
Immobilienscout24
Have a look at fetch-estate.ts and fetch-estates.ts to get an idea how to use the classes and functions
FlowFact
Have a look at fetch-estate.ts and fetch-estates.ts to get an idea how to use the classes and functions
TODO
- [ ] tests
- [x] unit-tests
- [ ] e2e-tests
- [x] integrate ci (github actions)
- [x] integrate semantic-release