Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miksus/finnish_business_portal
High level access to PRH and YTJ open data
https://github.com/miksus/finnish_business_portal
avoindata business-systems open-data prh python3 ytj
Last synced: 16 days ago
JSON representation
High level access to PRH and YTJ open data
- Host: GitHub
- URL: https://github.com/miksus/finnish_business_portal
- Owner: Miksus
- License: mit
- Created: 2019-01-17T09:31:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-22T12:54:27.000Z (almost 3 years ago)
- Last Synced: 2024-10-10T17:44:08.504Z (about 1 month ago)
- Topics: avoindata, business-systems, open-data, prh, python3, ytj
- Language: Python
- Homepage:
- Size: 130 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Finnish Business Portal
> Python interface for PRH corporate data
> Open Data, Python 3
---
## Features
- Query data using simple syntax
- Complete access to the APIs and parameters provided by PRH
### Upcoming Features
- Load query parameters from Excel file
- Generate template for query parameters
- Default queries for addresses, contact details et cetera
### Possible Features
- Graphical User Interface
---
## Prerequisites
```
Python 3
Pandas
Requests
```
## Example
> Querying the API for companies named _Nokia_ and _Fortum_ that are registered after year 2000
```python
import finnish_business_portal as busportal
# Selecting BisCompany API
portal = busportal.SearchModel("BisCompany")
portal.search(name=["fortum", "nokia"], company_registration_from="2000-01-01")
portal.to_frame().results
```
> Getting all available APIs
```python
busportal.api_infos
```
> and parameters
```python
busportal.SearchModel("BisCompany").parameter_infos
```
> Querying all information and saving to Excel:
```python
portal = busportal.SearchModel("BisCompany", loop_results=True, deep=True)
portal.search(name=["fortum", "nokia"], company_registration_from="2000-01-01")
portal.to_frame().results.to_excel("mydata.xlsx")
```
> Please see [Demo](demo.ipynb) for thorough examples
---
## Author
* **Mikael Koli** - [Miksus](https://github.com/Miksus) - [email protected]
---
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details