Eign Location Intelligence

Overview

The Eign Location Intelligence API provides normalised 0–10 index scores across four dimensions — living, transportation, community, and nature — for any address or coordinate pair within UAE and Canada.

All endpoints are versioned under /v1/. Index endpoints live at /v1/index/<category> and the geocoding utility lives at /v1/location/geocode.

Base URL

https://api.eign.com

Authentication

All /v1/* endpoints require a key in the request header. Every API call must include your key in the X-API-Key header. Keys are prefixed with eign_live_.

GET /v1/index/living?address=Dubai+Marina HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Scopes

Each key is issued with a set of OAuth-style scopes that gate access to index categories.

Rate Limits

Limits are enforced per API key, per rolling window.

When a limit is reached the API returns 429 Too Many Requests with a Retry-After header indicating seconds until reset. Every response includes your current quota status in the meta field.

Response Format

Every endpoint — success or failure — returns the same JSON envelope.

{
  "success": true,
  "data": {
    "index": "living",
    "overall_score": 8.4,
    "label": "Excellent",
    "coordinates": { "lat": 25.2048, "lng": 55.2708 },
    "country": "AE",
    "sub_indices": { /* category-specific */ },
    "generated_at": "2025-04-13T10:22:00Z"
  },
  "error": null,
  "meta": {
    "request_id": "req_01hvx...",
    "timestamp": "2025-04-13T10:22:00.431Z",
    "version": "v1",
    "quota_used_today": 42,
    "quota_limit_today": 1000,
    "quota_remaining_today": 958
  }
}

Fields

Score Scale

Every index and sub-index returns a normalised score from 0 to 10 plus a human-readable label.

Sub-indices can be independently weighted in your application if the defaults don't fit your use case — the raw score value is always provided alongside the label.

Location

Resolve an address string to coordinates before querying indices, or use with any index endpoint directly via the address parameter.

GET /v1/location/geocode?address=Palm+Jumeirah%2C+Dubai HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Living Index

Measures the day-to-day livability of a location — dining options, retail access, healthcare proximity, and pedestrian friendliness.

GET /v1/index/living?lat=25.2048&lng=55.2708&radius=1500 HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Transportation Index

Evaluates how connected a location is to public transit, road networks, and active transport infrastructure.

GET /v1/index/transportation?address=Downtown+Dubai HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Community Index

Characterises the social fabric of a neighbourhood — density, safety signals, amenity variety, family suitability, and ambient noise.

GET /v1/index/community?lat=43.6532&lng=-79.3832 HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Nature Index

Quantifies the environmental quality surrounding a location — greenery, air, park access, tree cover, and ecological risk.

GET /v1/index/nature?address=Jumeirah+Beach+Residence HTTP/1.1
X-API-Key: eign_live_••••••••••••••••

Errors

All errors follow the standard response envelope with success: false and a machine-readable error.code.

Response Headers

Useful metadata is surfaced in response headers on every call.