Developers

Loc8ID API

Create and manage Loc8IDs programmatically. Requires a Business plan API key.

Base URL: https://loc8id.com/api Get an API key →

Try it

Make a live request right here—no curl or Postman needed. Uses your real API key against your account.

POST /api/loc8ids

API Key

Latitude *

Longitude *

Name (optional)

Response

Authentication

Every request must include your API key as a Bearer token:

Authorization: Bearer loc8id_your_key_here

Keys are created in your Dashboard → API Keys. Each key is shown only once at creation.

Endpoints

POST /api/loc8ids API Key required

Create a new Loc8ID for a geographic coordinate. Returns a short URL immediately.

Request body · application/json

Field	Type	Required	Description
latitude	number	Yes	−90 to 90
longitude	number	Yes	−180 to 180
name	string	No	Label for this location
description	string	No	Additional details
custom_slug	string	No	Custom short code (Business)

Code samples

curl -X POST https://loc8id.com/api/loc8ids \
  -H "Authorization: Bearer loc8id_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "latitude": 40.7580,
    "longitude": -73.9855,
    "name": "Times Square"
  }'

const response = await fetch('https://loc8id.com/api/loc8ids', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer loc8id_your_key_here',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    latitude: 40.7580,
    longitude: -73.9855,
    name: 'Times Square',
  }),
});

const data = await response.json();
console.log(data.data.url); // https://loc8id.com/xk7m

import requests

response = requests.post(
    'https://loc8id.com/api/loc8ids',
    headers={
        'Authorization': 'Bearer loc8id_your_key_here',
        'Content-Type': 'application/json',
    },
    json={
        'latitude': 40.7580,
        'longitude': -73.9855,
        'name': 'Times Square',
    }
)

data = response.json()
print(data['data']['url'])  # https://loc8id.com/xk7m

$ch = curl_init('https://loc8id.com/api/loc8ids');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer loc8id_your_key_here',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'latitude'  => 40.7580,
        'longitude' => -73.9855,
        'name'      => 'Times Square',
    ]),
]);

$response = json_decode(curl_exec($ch), true);
echo $response['data']['url']; // https://loc8id.com/xk7m

Response · 201 Created

{
  "success": true,
  "data": {
    "loc8id": "xk7m",
    "url": "https://loc8id.com/xk7m",
    "latitude": 40.758,
    "longitude": -73.9855,
    "name": "Times Square",
    "description": null,
    "is_custom_slug": false
  }
}

GET /api/collections/{id}/items Public

Returns all Loc8IDs in a public collection. No authentication required.

curl https://loc8id.com/api/collections/your-collection-id/items

const response = await fetch(
  'https://loc8id.com/api/collections/your-collection-id/items'
);
const data = await response.json();
console.log(data.data); // array of loc8id objects

import requests

response = requests.get(
    'https://loc8id.com/api/collections/your-collection-id/items'
)
data = response.json()
print(data['data'])  # list of loc8id dicts

$response = json_decode(
    file_get_contents('https://loc8id.com/api/collections/your-collection-id/items'),
    true
);
print_r($response['data']);

Response · 200 OK

{
  "success": true,
  "data": [
    {
      "loc8id": "xk7m",
      "url": "https://loc8id.com/xk7m",
      "name": "Times Square",
      "latitude": 40.758,
      "longitude": -73.9855
    }
  ]
}

Rate Limits

Rate limit status is returned in every response header.

Business

60 req / min

Response headers

X-RateLimit-Limit · X-RateLimit-Remaining · X-RateLimit-Reset

Exceeding the limit returns 429 Too Many Requests. The X-RateLimit-Reset header tells you when the window resets (Unix timestamp).

Error Codes

All errors return JSON with a message field.

Code	Meaning
201	Created — Loc8ID created successfully
400	Bad Request—missing or invalid parameters
401	Unauthorized—missing, invalid, or revoked API key
403	Forbidden—plan limit reached or insufficient permissions
404	Not Found
429	Too Many Requests—rate limit exceeded, check `X-RateLimit-Reset`
500	Server Error—try again, contact support if it persists

Ready to build?

API access is included on the Business plan.

View Pricing Manage API Keys