---
title: "Geolocation with GeoIP2"
version: 3.1
locale: ko
source: https://docs.djangoproject.com/ko/3.1/ref/contrib/gis/geoip2/
canonical: https://djangodocs.dev/ko/3.1/ref/contrib/gis/geoip2/
---
# Geolocation with GeoIP2

The [`GeoIP2`](#django.contrib.gis.geoip2.GeoIP2) object is a wrapper for the [MaxMind geoip2 Python
library](https://geoip2.readthedocs.io/). [^1]

In order to perform IP-based geolocation, the [`GeoIP2`](#django.contrib.gis.geoip2.GeoIP2) object requires
the [geoip2 Python library](https://pypi.org/project/geoip2/) and the GeoIP `Country` and/or `City`
[datasets in binary format](https://dev.maxmind.com/geoip/geoip2/geolite2/) (the CSV files will not work!). Grab the
`GeoLite2-Country.mmdb.gz` and `GeoLite2-City.mmdb.gz` files and unzip them
in a directory corresponding to the [`GEOIP_PATH`](#std-setting-GEOIP_PATH) setting.

Additionally, it is recommended to install the [libmaxminddb C library](https://github.com/maxmind/libmaxminddb), so
that `geoip2` can leverage the C library’s faster speed.

## Example

Here is an example of its usage:

```
>>> from django.contrib.gis.geoip2 import GeoIP2
>>> g = GeoIP2()
>>> g.country('google.com')
{'country_code': 'US', 'country_name': 'United States'}
>>> g.city('72.14.207.99')
{'city': 'Mountain View',
'continent_code': 'NA',
'continent_name': 'North America',
'country_code': 'US',
'country_name': 'United States',
'dma_code': 807,
'is_in_european_union': False,
'latitude': 37.419200897216797,
'longitude': -122.05740356445312,
'postal_code': '94043',
'region': 'CA',
'time_zone': 'America/Los_Angeles'}
>>> g.lat_lon('salon.com')
(39.0437, -77.4875)
>>> g.lon_lat('uh.edu')
(-95.4342, 29.834)
>>> g.geos('24.124.1.80').wkt
'POINT (-97 38)'
```

## API Reference

#### `class GeoIP2(path=None, cache=0, country=None, city=None)`

The `GeoIP` object does not require any parameters to use the default
settings. However, at the very least the [`GEOIP_PATH`](#std-setting-GEOIP_PATH) setting
should be set with the path of the location of your GeoIP datasets. The
following initialization keywords may be used to customize any of the
defaults.

| Keyword Arguments | Description |
| --- | --- |
| `path` | Base directory to where GeoIP data is located or the<br>full path to where the city or country data files<br>(`.mmdb`) are located. Assumes that both the city and<br>country datasets are located in this directory;<br>overrides the [`GEOIP_PATH`](#std-setting-GEOIP_PATH) setting. |
| `cache` | The cache settings when opening up the GeoIP datasets. May<br>be an integer in (0, 1, 2, 4, 8) corresponding to the<br>`MODE_AUTO`, `MODE_MMAP_EXT`, `MODE_MMAP`, and<br>`GEOIP_INDEX_CACHE` `MODE_MEMORY` C API settings,<br>respectively. Defaults to 0 (`MODE_AUTO`). |
| `country` | The name of the GeoIP country data file. Defaults<br>to `GeoLite2-Country.mmdb`. Setting this keyword<br>overrides the [`GEOIP_COUNTRY`](#std-setting-GEOIP_COUNTRY) setting. |
| `city` | The name of the GeoIP city data file. Defaults to<br>`GeoLite2-City.mmdb`. Setting this keyword overrides<br>the [`GEOIP_CITY`](#std-setting-GEOIP_CITY) setting. |

> **Changed in Django 3.0**
>
> Support for [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path) `path` was added.

## Methods

### Instantiating

#### `classmethod GeoIP2.open(path, cache)`

This classmethod instantiates the GeoIP object from the given database path
and given cache setting.

### Querying

All the following querying routines may take either a string IP address
or a fully qualified domain name (FQDN). For example, both
`'205.186.163.125'` and `'djangoproject.com'` would be valid query
parameters.

#### `GeoIP2.city(query)`

Returns a dictionary of city information for the given query. Some
of the values in the dictionary may be undefined (`None`).

#### `GeoIP2.country(query)`

Returns a dictionary with the country code and country for the given
query.

#### `GeoIP2.country_code(query)`

Returns the country code corresponding to the query.

#### `GeoIP2.country_name(query)`

Returns the country name corresponding to the query.

### Coordinate Retrieval

#### `GeoIP2.coords(query)`

Returns a coordinate tuple of (longitude, latitude).

#### `GeoIP2.lon_lat(query)`

Returns a coordinate tuple of (longitude, latitude).

#### `GeoIP2.lat_lon(query)`

Returns a coordinate tuple of (latitude, longitude),

#### `GeoIP2.geos(query)`

Returns a [`Point`](/ko/3.1/ref/contrib/gis/geos/#django.contrib.gis.geos.Point) object corresponding to the
query.

## Settings

### `GEOIP_PATH`

A string or [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path) specifying the directory where the GeoIP data
files are located. This setting is *required* unless manually specified
with `path` keyword when initializing the [`GeoIP2`](#django.contrib.gis.geoip2.GeoIP2) object.

> **Changed in Django 3.0**
>
> Support for [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path) was added.

### `GEOIP_COUNTRY`

The basename to use for the GeoIP country data file. Defaults to
`'GeoLite2-Country.mmdb'`.

### `GEOIP_CITY`

The basename to use for the GeoIP city data file. Defaults to
`'GeoLite2-City.mmdb'`.

## Exceptions

#### `exception GeoIP2Exception`

The exception raised when an error occurs in a call to the underlying
`geoip2` library.

**Footnotes**

[^1]: GeoIP(R) is a registered trademark of MaxMind, Inc.