Skip to content

GeolocationApi.md

Latest commit

 

History

History
171 lines (115 loc) · 5.21 KB

GeolocationApi.md

File metadata and controls

171 lines (115 loc) · 5.21 KB
Raw

whoisfreaks.GeolocationApi

All URIs are relative to https://api.whoisfreaks.com

Method HTTP request Description
bulk_geolocation POST /v1.0/geolocation Bulk IP Geolocation
geolocation GET /v1.0/geolocation IP Geolocation Lookup

bulk_geolocation

List[GeolocationResponse] bulk_geolocation(bulk_geolocation_request)

Bulk IP Geolocation

Up to 100 IPs.

Example

  • Api Key Authentication (ApiKeyAuth):
import whoisfreaks
from whoisfreaks.models.bulk_geolocation_request import BulkGeolocationRequest
from whoisfreaks.models.geolocation_response import GeolocationResponse
from whoisfreaks.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whoisfreaks.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whoisfreaks.GeolocationApi(api_client)
    bulk_geolocation_request = whoisfreaks.BulkGeolocationRequest() # BulkGeolocationRequest | 

    try:
        # Bulk IP Geolocation
        api_response = api_instance.bulk_geolocation(bulk_geolocation_request)
        print("The response of GeolocationApi->bulk_geolocation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeolocationApi->bulk_geolocation: %s\n" % e)

Parameters

Name Type Description Notes
bulk_geolocation_request BulkGeolocationRequest

Return type

List[GeolocationResponse]

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
4XX Error response (4XX) -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

geolocation

GeolocationResponse geolocation(ip)

IP Geolocation Lookup

Get location, ASN, currency for an IP. 1 credit.

Example

  • Api Key Authentication (ApiKeyAuth):
import whoisfreaks
from whoisfreaks.models.geolocation_response import GeolocationResponse
from whoisfreaks.rest import ApiException
from pprint import pprint

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

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with whoisfreaks.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = whoisfreaks.GeolocationApi(api_client)
    ip = 'ip_example' # str | 

    try:
        # IP Geolocation Lookup
        api_response = api_instance.geolocation(ip)
        print("The response of GeolocationApi->geolocation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GeolocationApi->geolocation: %s\n" % e)

Parameters

Name Type Description Notes
ip str

Return type

GeolocationResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
4XX Error response (4XX) -

[Back to top] [Back to API list] [Back to Model list] [Back to README]