APIs

geoPin is a public reporting platform designed to assist residents in notifying local authorities of environmental or infrastructure issues such as potholes, damaged streetlights, and fly-tipping. By providing accurate location data and clear issue details, geoPin enables councils and service teams to efficiently manage, prioritise, and resolve reports within their communities.

Public API

The geoPin Public API allows developers and organisations to test integration of location-based issue reporting directly into their own systems and applications. Using the API, reports of potholes, damaged streetlights, fly-tipping, and other community issues can be retrieved and managed programmatically, enabling seamless collaboration with local authorities and improved service efficiency.

Usage Policy

The geoPin Public API is intended for non-commercial use only. It may be freely used by developers, researchers, educational institutions, and non-profit organisations for testing integration. Commercial entities, local councils, and government agencies must use the Premium API, see details below. Individuals wanting access must use the Personal API, see details below.

The Public API is rate-limited and provides partial access to reported issues.

Example: Using the Public API

This example shows how to retrieve reported issues using the geoPin Public API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/public/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "emailAddress": "public@geopin.co.uk",
            "apiKey": "9128eb0134e891a3c7b0b594a181cc8cc1e75c0a947b9de2169851cc28523942"
          },
          "action": "get_enquiries",
          "parameters": {
            "oslaua": "E07000243",
            "epochStart": 1759151203,
            "epochEnd": 1761746803
          }
        }'

Parameters:

mailAddress — Public API Email Address
apiKey — Public API key
oslaua — Local authority identifier
action — The API action to perform (e.g., get_enquiries)
epochStart — Start of the time range (Unix epoch). This parameter is optional; if omitted it defaults to thirty days ago
epochEnd — End of the time range (Unix epoch). This parameter is optional; if omitted it defaults to now

Test the Public API

You can check out the Public API using the link below.
Test the Public API

Example: Using the Public API

This example shows how to retrieve all oslaua using the geoPin Public API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/public/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "emailAddress": "public@geopin.co.uk",
            "apiKey": "9128eb0134e891a3c7b0b594a181cc8cc1e75c0a947b9de2169851cc28523942"
          },
          "action": "get_oslaua_list"
        }'

Parameters:

mailAddress — Public API Email Address
apiKey — Public API key
action — The API action to perform (e.g., get_oslaua_list)

Test the Public API

You can check out the Public API using the link below.
Test the Public API

Premium API

The geoPin Premium API provides advanced access and enhanced functionality for organisations requiring deeper integration and greater data capabilities. It offers extended endpoints for analytics, bulk data retrieval, and detailed status tracking of reports. Designed for councils, contractors, and infrastructure partners, the Premium API delivers higher rate limits, priority support, and comprehensive insights to optimise service delivery and resource management.
The Premium API is available under licence, please contact support@geopin.co.uk for more information.

Example: Using the Premium API

This example shows how to retrieve reported issues using the geoPin Premium API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/premium/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "oslaua": "[OSLAUA]",
            "apiKey": "[OSLAUA_API_KEY]"
          },
          "action": "get_enquiries",
          "parameters": {
            "epochStart": 1759151203,
            "epochEnd": 1761746803
          }
        }'

Parameters:

oslaua — Local authority identifier
apiKey — Local authority API key
action — The API action to perform (e.g., get_enquiries)
epochStart — Start of the time range (Unix epoch). This parameter is optional; if omitted it defaults to thirty days ago
epochEnd — End of the time range (Unix epoch). This parameter is optional; if omitted it defaults to now

Example: Using the Premium API

This example shows how to retrieve reported issues using the geoPin Premium API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/premium/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "oslaua": "[OSLAUA]",
            "apiKey": "[OSLAUA_API_KEY]"
          },
          "action": "get_oslaua_list"
        }'

Parameters:

oslaua — Local authority identifier
apiKey — Local authority API key
action — The API action to perform (e.g., get_oslaua_list)

Personal API

The geoPin Personal API provides advanced access and enhanced functionality for individuals requiring deeper integration and greater data capabilities. It offers extended endpoints for analytics, bulk data retrieval, and detailed status tracking of reports. Designed for single users and application developers, the Personal API delivers higher rate limits, priority support, and comprehensive insights to optimise service delivery and resource management.
The Personal API is available under licence, please contact support@geopin.co.uk for more information.

Example: Using the Personal API

This example shows how to retrieve reported issues using the geoPin Personal API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/personal/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "emailAddress": "[EMAIL_ADDRESS]",
            "apiKey": "[API_KEY]"
          },
          "action": "get_enquiries",
          "parameters": {
            "epochStart": 1759151203,
            "epochEnd": 1761746803
          }
        }'

Parameters:

emailAddress — Personal Email Address
apiKey — Personal API key
action — The API action to perform (e.g., get_enquiries)
epochStart — Start of the time range (Unix epoch). This parameter is optional; if omitted it defaults to thirty days ago
epochEnd — End of the time range (Unix epoch). This parameter is optional; if omitted it defaults to now

Example: Using the Personal API

This example shows how to retrieve reported issues using the geoPin Personal API with a cURL POST request:

curl -X POST https://geopin.co.uk/api/v1/personal/ \
        -H "Content-Type: application/json" \
        -d '{
          "auth": {
            "emailAddress": "[EMAIL_ADDRESS]",
            "apiKey": "[API_KEY]"
          },
          "action": "get_oslaua_list"
        }'

Parameters:

emailAddress — Personal Email Address
apiKey — Personal API key
action — The API action to perform (e.g., get_oslaua_list)