Metadata-Version: 2.1
Name: statsnz
Version: 1.0.7
Summary: A collection of functions to enable ease of use of the various Stats NZ APIs
Home-page: https://github.com/basanovase/statsnz
Author: Flynn
Author-email: flynn.mclean@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: pandas
Requires-Dist: requests

# statsnz

A collection of functions to enable ease of use of the various Stats New Zealand APIs, in python.

Installion:

  pip install statsnz



Examples:


Geocoding:


  To get the region with a set of coordinates:

    from statsnz import statsnz

    region_example = statsnz("YOUR_API_KEY").get_region(-41.242,172.323)


  Or TLA:

    region_example = statsnz("YOUR_API_KEY").get_tla(-41.242,172.323)

  Or DHB:

      region_example = statsnz("YOUR_API_KEY").get_dhb(-41.242,172.323)



  Or a custom layer:

    region_example = statsnz("YOUR_API_KEY").get_custom(-41.242,172.323)


Odata API:


    from statsnz import statsnz

    statsnz = statsnz("YOUR_API_KEY")
    service = 'https://api.stats.govt.nz/opendata/v1'
    endpoint = 'EmploymentIndicators'
    entity = 'Resources'
    query_option = "10" ##Top 10 records



    Observations = statsnz.get_odata_api(service, endpoint, entity, query_option)


