https://github.com/geovation/catalyst-ons-proxy-api-azure

A proxy API for appending OS geographies to API calls
https://github.com/geovation/catalyst-ons-proxy-api-azure

Last synced: about 1 year ago
JSON representation

A proxy API for appending OS geographies to API calls

• Host: GitHub
• URL: https://github.com/geovation/catalyst-ons-proxy-api-azure
• Owner: Geovation
• License: mit
• Created: 2025-01-09T10:15:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-22T14:23:43.000Z (over 1 year ago)
• Last Synced: 2025-02-03T06:54:49.116Z (over 1 year ago)
• Language: Python
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Office for National Statistics data proxy API

A proxy API for appending ONS lookup data to API calls for OS data.

## Setup

This is a Azure Function App written in Python. You can run it locally using the Azure Functions Core Tools and in VSCode with the Azure Functions extension.

## Endpoints

The Azure function supports all the endpoints of the OS Places API. The documentation for the OS Places API can be found [on the technical specification page](https://osdatahub.os.uk/docs/places/technicalSpecification).

| Endpoint | Description |

| --- | --- |

| /places/{operation} | A proxy for the various places endpoints |

## Data returned

The data returned by the proxy API is the same as the data returned by the OS Places API, with the addition of the ONS lookup data. The ONS lookup data is returned in the `ons` key for each response item.

```json

```