RandomCoords REST API Documentation

Your API Token

5444d9dc5e7f4fa70a9a842bfe393f02:f2c36625cb5897c2b89947717b821c102b48133494fb536d597f26549f618c4c151f95f04c809c1154a34b4a2708adefe6a2bf530822ed4e6f8f4625ee1465a73713bce00bda2f02c9bbd2e85369c805
All APIs require x-api-token in header. By using the RandomCoords APIs, you agree to the Terms and Conditions.
The client libraries are available for:

APIs

Get Regions

GET https://api.randomcoords.com/v1/coordinates/regions
Response
{
  type: "regions";
  results: number;
  data: {
    id: string;
    name: string;
  }[];
}

Get Random Coordinates in a Region

GET https://api.randomcoords.com/v1/coordinates/regions/{region}?limit={number}

Query Parameters: limit (optional, max 100, default 1)

Response
{
  id: string;
  name: string;
  type: "region";
  results: number;
  data: {
    id: string;
    country: string;
    city: string;
    iso2: string;
    coordinates: [number, number];
  }[];
}

Get Countries

GET https://api.randomcoords.com/v1/coordinates/countries
Response
{
  type: "countries";
  results: number;
  data: {
    id: string;
    name: string;
    iso2: string;
  }[];
}

Get Random Coordinates in a Country

GET https://api.randomcoords.com/v1/coordinates/countries/{country}?limit={number}

Query Parameters: limit (optional, max 100, default 1)

Response
{
  id: string;
  name: string;
  type: "country";
  regions: string[];
  iso2: string;
  results: number;
  data: {
    city: string;
    state?: string;
    coordinates: [number, number];
  }[];
}

Status Codes

  • 200 - Success.
  • 401 - Unauthorized.
    • Ensure x-api-token in the header is not malformed.
  • 403 - Forbidden.
    • Confirm x-api-token exists in the header.
    • Ensure the URL is valid.
  • 404 - Not Found.
    • Verify the identifiers in the URL (e.g., region or country) are correct.
  • 429 - Too Many Requests.
    • Wait before retrying.
    • Cache results whenever possible.
401 and 404 responses return a JSON object with a message field:
Response
{
  message: string;  
}