openapiiplocation 1.2.0
iplocation.net API
License: MIT
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, iplocation.net API

# openapiiplocation
OpenAPI v3 specification and a set of generated API clients for iplocation.net

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.2.0
- Package version: 1.2.0
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/oapicf/openapi-iplocation](https://github.com/oapicf/openapi-iplocation)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/oapicf/openapi-iplocation.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/oapicf/openapi-iplocation.git`)

Then import the package:
```python
import openapiiplocation
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import openapiiplocation
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openapiiplocation
from openapiiplocation.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.iplocation.net
# See configuration.py for a list of all supported configuration parameters.
configuration = openapiiplocation.Configuration(
    host = "https://api.iplocation.net"
)



# Enter a context with an instance of the API client
with openapiiplocation.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapiiplocation.DefaultApi(api_client)
    ip = 'ip_example' # str | An IPv4 or IPv6 address that you would like to lookup.
    format = 'format_example' # str | Output format, the following formats are supported: plain xml json jsonp php csv serialized (optional)
    delimiter = 'delimiter_example' # str | Delimiter between proxies. Can be used only with format plain. The following types are supported: 1 for \"\\n\", 2 for \"<br>\". (optional)

    try:
        # Get geolocation of an IP address
        api_response = api_instance.root_get(ip, format=format, delimiter=delimiter)
        print("The response of DefaultApi->root_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->root_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.iplocation.net*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**root_get**](docs/DefaultApi.md#root_get) | **GET** / | Get geolocation of an IP address


## Documentation For Models

 - [Get200Response](docs/Get200Response.md)
 - [Get400Response](docs/Get400Response.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

blah+oapicf@cliffano.com