RandomCoords REST API Documentation

Your API Token

120452489a418c3803d559491b0cc3d1:0aad08369add2a876a97c8de0e25c27509a3fc959143d87d3d5584f0137fec551bc0bb39a544e99686bf15a74fc519047606f764e7cf3d9983cca0bb3a38005da9c1c81e85b66819fafafad3707be60c
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;
  }[];
}
Example cURL
curl --location --request GET 'https://api.randomcoords.com/v1/coordinates/regions' --header 'x-api-token: 120452489a418c3803d559491b0cc3d1:0aad08369add2a876a97c8de0e25c27509a3fc959143d87d3d5584f0137fec551bc0bb39a544e99686bf15a74fc519047606f764e7cf3d9983cca0bb3a38005da9c1c81e85b66819fafafad3707be60c'

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];
  }[];
}
Example cURL
curl --location --request GET 'https://api.randomcoords.com/v1/coordinates/regions/south-america?limit=5' --header 'x-api-token: 120452489a418c3803d559491b0cc3d1:0aad08369add2a876a97c8de0e25c27509a3fc959143d87d3d5584f0137fec551bc0bb39a544e99686bf15a74fc519047606f764e7cf3d9983cca0bb3a38005da9c1c81e85b66819fafafad3707be60c'

Get Countries

GET https://api.randomcoords.com/v1/coordinates/countries
Response
{
  type: "countries";
  results: number;
  data: {
    id: string;
    name: string;
    iso2: string;
  }[];
}
Example cURL
curl --location --request GET 'https://api.randomcoords.com/v1/coordinates/countries' --header 'x-api-token: 120452489a418c3803d559491b0cc3d1:0aad08369add2a876a97c8de0e25c27509a3fc959143d87d3d5584f0137fec551bc0bb39a544e99686bf15a74fc519047606f764e7cf3d9983cca0bb3a38005da9c1c81e85b66819fafafad3707be60c'

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];
  }[];
}
Example cURL
curl --location --request GET 'https://api.randomcoords.com/v1/coordinates/countries/united-states?limit=5' --header 'x-api-token: 120452489a418c3803d559491b0cc3d1:0aad08369add2a876a97c8de0e25c27509a3fc959143d87d3d5584f0137fec551bc0bb39a544e99686bf15a74fc519047606f764e7cf3d9983cca0bb3a38005da9c1c81e85b66819fafafad3707be60c'

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;  
}