get/ip

Get client geolocation

Resolves the approximate location of the requesting client from its IP address, together with the locations where age restricted content is gated or unavailable.

get_client_geolocation

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "countryCode": {
      "description": "ISO 3166-1 alpha-2 country code resolved for the client, or null when it cannot be resolved",
      "type": [
        "string",
        "null"
      ]
    },
    "regionCode": {
      "description": "ISO 3166-2 subdivision code resolved for the client, or null when it cannot be resolved",
      "type": [
        "string",
        "null"
      ]
    },
    "latitude": {
      "description": "Approximate latitude of the client, or null when it cannot be resolved",
      "type": [
        "string",
        "null"
      ]
    },
    "longitude": {
      "description": "Approximate longitude of the client, or null when it cannot be resolved",
      "type": [
        "string",
        "null"
      ]
    },
    "ageRestrictedGeos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GeoEntry"
      },
      "description": "Locations where age restricted content requires an age check"
    },
    "ageBlockedGeos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GeoEntry"
      },
      "description": "Locations where age restricted content is unavailable"
    }
  },
  "required": [
    "countryCode",
    "regionCode",
    "latitude",
    "longitude",
    "ageRestrictedGeos",
    "ageBlockedGeos"
  ],
  "additionalProperties": false
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}