Infoxchange Locations API Python client

A Python client for the Infoxchange Locations API, generated from its OpenAPI schema with openapi-python-client.

Requires Python 3.11+.

Installation

pip install ix-locations-api

Usage

Each API operation is a module under ix_locations_api.api with sync, sync_detailed, asyncio and asyncio_detailed functions. The *_detailed versions return the full response including the status code, the others return just the parsed body (or None if the request wasn't successful).

from ix_locations_api import AuthenticatedClient
from ix_locations_api.api.search import search_suburbs_list

client = AuthenticatedClient(base_url="https://locations-api.dev.ixapps.org", token="<access token>")

page = search_suburbs_list.sync(client=client, search="Abbotsford", state="VIC")
for suburb in page.results:
    print(suburb.name, suburb.postcode, suburb.centroid)

To get an access token with a username and password:

from ix_locations_api import AuthenticatedClient, Client
from ix_locations_api.api.token import token_create
from ix_locations_api.models import TokenObtainPairRequest

tokens = token_create.sync(
    client=Client(base_url="https://locations-api.dev.ixapps.org"),
    body=TokenObtainPairRequest(username="...", password="..."),
)
client = AuthenticatedClient(base_url="https://locations-api.dev.ixapps.org", token=tokens.access)

The API documentation is available on the home page of the API (e.g. https://locations-api.dev.ixapps.org/).

Development

The ix_locations_api package is generated from openapi.yaml at the root of this repo and isn't committed. To generate it and build the package:

./generate.sh
uv build

New versions are published to PyPI automatically when a release is tagged.