Tuxa API

Quick Start

You can make your first API call in under two minutes. Follow these three steps:

curl -X POST https://tuxa.co.uk/api/v1/lookup \
  -H "Authorization: Bearer tuxa_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"address": "14 Coldharbour Lane, London SE5 9NR"}'

Authentication

All API requests must include your API key in the Authorization header using the Bearer scheme. API keys begin with tuxa_.

Authorization: Bearer tuxa_your_api_key_here

API keys are tied to your Tuxa account and deduct from your credit balance. Keep your key secret and never expose it in client-side code.

Pricing and Credits

The Tuxa API uses a credit-based pricing model. Each successful POST /lookup request deducts one credit from your balance. New accounts receive 10 free trial credits on sign-up. Credits never expire.

Enterprise contracts include volume discounts, SLA guarantees, and dedicated support. Contact [email protected] to discuss your requirements.

Interactive Playground

Try a live lookup directly in your browser. Enter any UK address and your API key to see the full response.

Base URL

All API endpoints are relative to the following base URL:

https://tuxa.co.uk/api/v1

POST /lookup

Check whether a UK property address falls within a selective or additional licensing scheme. Provide an address string, a UPRN, or precise coordinates. Deducts 1 credit per successful request.

Request body

Example requests

curl -X POST https://tuxa.co.uk/api/v1/lookup \
  -H "Authorization: Bearer tuxa_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"address": "14 Coldharbour Lane, London SE5 9NR"}'

Example response

{
  "address": "14 Coldharbour Lane, London SE5 9NR",
  "coordinates": {
    "latitude": 51.4675,
    "longitude": -0.0922
  },
  "council": {
    "id": 42,
    "name": "London Borough of Southwark",
    "code": "southwark"
  },
  "licensing": {
    "requiresLicense": true,
    "licenseType": "selective",
    "schemes": [
      {
        "id": 87,
        "name": "Southwark Selective Licensing Scheme",
        "type": "Selective",
        "startDate": "2023-04-01",
        "endDate": "2028-03-31",
        "description": "Borough-wide selective licensing scheme.",
        "moreInfoUrl": "https://www.southwark.gov.uk/housing/private-sector-housing/licensing"
      }
    ]
  },
  "geocoding": {
    "source": "os_places",
    "uprn": "100021892955"
  },
  "meta": {
    "creditsRemaining": 49,
    "checkedAt": "2026-03-26T14:22:01.000Z"
  }
}

Response fields

Licence type values

GET /credits

Returns the current credit balance for the authenticated API key. Does not deduct any credits.

Example request

curl https://tuxa.co.uk/api/v1/credits \
  -H "Authorization: Bearer tuxa_your_api_key_here"

Example response

{
  "creditsRemaining": 49
}

Error Handling

The API uses standard HTTP status codes. All error responses include an error field and a human-readable message.

Error response format

{
  "error": "payment_required",
  "message": "You have no API credits remaining. Top up to continue making lookups.",
  "creditsRemaining": 0,
  "topUpUrl": "https://tuxa.co.uk/credits",
  "docsUrl": "https://tuxa.co.uk/api-docs#pricing"
}

Code Examples

const response = await fetch('https://tuxa.co.uk/api/v1/lookup', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer tuxa_your_api_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    address: '14 Coldharbour Lane, London SE5 9NR',
  }),
});

const data = await response.json();

if (data.licensing.requiresLicense) {
  console.log(`Licence required: ${data.licensing.licenseType}`);
  data.licensing.schemes.forEach(scheme => {
    console.log(`  - ${scheme.name} (${scheme.type})`);
  });
} else {
  console.log('No licensing scheme applies to this property.');
}
console.log(`Credits remaining: ${data.meta.creditsRemaining}`);

Manage Your API Keys

Create and revoke API keys from your account below. Each key is shown in full only once at creation time — store it securely in your application's environment variables.