API Reference

Public REST API

The public endpoints are designed for client-side integration and high-traffic fetch requests. Authentication is handled via your project's Public API Key (pk_...).

Base URL

https://api.slaaad.com

GET

Get Terrain Details

Fetches metadata for a specific terrain, including its grid dimensions and configuration.

Request Path/v1/public/terrains/:id

{
  "success": true,
  "data": {
    "id": 8,
    "name": "Global Billboard",
    "rows": 10,
    "cols": 20,
    "backgroundImageUrl": "https://cdn.slaaad.com/bg.png",
    "isTransparent": true,
    "uiConfig": { "theme": "dark" }
  }
}

GET

Get All Plots

Retrieves the current status of all cells within a terrain.

Request Path/v1/public/plots?terrainId=:id

[
  {
    "plotId": 124,
    "row": 0,
    "col": 5,
    "status": "OCCUPIED",
    "imageUrl": "https://img.host.com/plot124.jpg",
    "ownerExternalUserId": "user_abc_01"
  },
  {
    "plotId": 125,
    "row": 0,
    "col": 6,
    "status": "VACANT",
    "imageUrl": null
  }
]

API Authentication

Add your public API key to the request header to authenticate.

x-api-key: pk_test_019aX...

CORS Policy

All public endpoints support Cross-Origin Resource Sharing (CORS). Requests from any domain are allowed as long as a valid x-api-key is provided.

Last updated: April 2026