> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zype.com/llms.txt
> Use this file to discover all available pages before exploring further.

# View GeoIP

Retrieve the GeoIP object for a specific IP Address

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Platform",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.zype.com/"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "paths": {
    "/geoip": {
      "get": {
        "summary": "View GeoIP",
        "description": "Retrieve the GeoIP object for a specific IP Address",
        "tags": [
          "GeoIP"
        ],
        "operationId": "getGeoIP",
        "parameters": [
          {
            "name": "ip_address",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Defaults to the IP of the API caller if not provided"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "GeoIpResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "title": "GeoIp",
                      "type": "object",
                      "properties": {
                        "request": {
                          "type": "string"
                        },
                        "ip": {
                          "type": "string"
                        },
                        "country_code": {
                          "type": "string"
                        },
                        "country_code2": {
                          "type": "string"
                        },
                        "country_code3": {
                          "type": "string"
                        },
                        "country_name": {
                          "type": "string"
                        },
                        "continent_code": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```