A collection of example Python scripts to guide users as to how they might retrieve, parse and use data from the Logainm API (docs.gaois.ie).
To run on Windows, install Python (adding Python to PATH), open a command prompt (run cmd), navigate to the folder containing the script (i.e. > cd <PATH_TO_FOLDER_CONTAINING_SCRIPT>), and type python <SCRIPT_NAME>, e.g.
> cd C:\MyPythonScripts
> python logainm_api_results_to_table.py
This script gets a list of places of a specified type from a specified county in Ireland from the Logainm API and prints place metadata (one place per line) to a TSV formatted file with the following columns:
logainm_id | lat | lon | county | barony | parish | cats | names_en | names_ga
For example, for townlands (BF) in Carlow (100004), this would be the first five lines of output (vertical bars are inserted here for clarity):
3000 | 52.8268601272065 | -6.58634818810364 | 100004 Carlow | 1 Rathvilly | 1411069 Clonmore | townland | Ballaghaclay | Bealach an tSléibhe
3001 | 52.8388492391207 | -6.53371364645032 | 100004 Carlow | 1 Rathvilly | 1411069 Clonmore | townland | Ballinagilky | Baile na Giolcaí
3002 | 52.8365069012364 | -6.60636780935882 | 100004 Carlow | 1 Rathvilly | 1411069 Clonmore | townland | Ballyduff | An Baile Dubh
3003 | 52.8258526764742 | -6.60526952627927 | 100004 Carlow | 1 Rathvilly | 1411069 Clonmore | townland | Ballynakill | Baile na Coille
3004 | 52.8235812668175 | -6.54264046126135 | 100004 Carlow | 1 Rathvilly | 1411069 Clonmore | townland | Bellmount | Bellmount
...
This script requires the requests package. To install this package, run the following command, before you run the script:
> pip install requests
You will also need to assign values to certain variables before you run the script.
On Line 73, you will need to provide your Logainm API KEY. API keys can be obtained by registering here:
On Line 74, you will need to specify a Logainm COUNTY ID. A reference list of counties can be retrieved from the API at the following path:
https://www.logainm.ie/api/v1.0/counties?apiKey=API_KEY_HERE
On Line 75, you will need to specify a Logainm PLACE TYPE ID. A reference list of Irish place types (i.e. administrative units) can be retrieved from the API at the following path:
https://www.logainm.ie/api/v1.0/administrative-units?apiKey=API_KEY_HERE
This script can easily be modified to produce different output.
This script takes a track in GPX format and prints out the list of Logainm townlands the track intersects in a specified county.
This module gets all streets, townlands and towns in Ireland from the Logainm API and prints place metadata (one place per line) to a TSV formatted file with the following columns:
logainm_id | lat | lon | county | barony | parish | cats | names_en | names_ga