Skip to content

DatabasesIPGeolocationApi.md

Latest commit

 

History

History
289 lines (202 loc) · 7.15 KB

DatabasesIPGeolocationApi.md

File metadata and controls

289 lines (202 loc) · 7.15 KB
Raw

WhoisFreaks::DatabasesIPGeolocationApi

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

Method HTTP request Description
db_ip_city GET /v3.3/download/snapshot/ip/city IP to City Snapshot
db_ip_city_status GET /v3.3/status/snapshot/ip/city IP to City Snapshot Status
db_ip_country GET /v3.3/download/snapshot/ip/country IP to Country Snapshot
db_ip_country_status GET /v3.3/status/snapshot/ip/country IP to Country Snapshot Status

db_ip_city

File db_ip_city(date)

IP to City Snapshot

IP to City Snapshot. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesIPGeolocationApi.new
date = Date.parse('2013-10-20') # Date | 

begin
  # IP to City Snapshot
  result = api_instance.db_ip_city(date)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city: #{e}"
end

Using the db_ip_city_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_ip_city_with_http_info(date)

begin
  # IP to City Snapshot
  data, status_code, headers = api_instance.db_ip_city_with_http_info(date)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
date Date

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

db_ip_city_status

db_ip_city_status

IP to City Snapshot Status

IP to City Snapshot Status. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesIPGeolocationApi.new

begin
  # IP to City Snapshot Status
  result = api_instance.db_ip_city_status
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_status: #{e}"
end

Using the db_ip_city_status_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> db_ip_city_status_with_http_info

begin
  # IP to City Snapshot Status
  data, status_code, headers = api_instance.db_ip_city_status_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SnapshotStatus>
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_city_status_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

SnapshotStatus

Authorization

ApiKeyAuth

HTTP request headers

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

db_ip_country

File db_ip_country(date)

IP to Country Snapshot

IP to Country Snapshot. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesIPGeolocationApi.new
date = Date.parse('2013-10-20') # Date | 

begin
  # IP to Country Snapshot
  result = api_instance.db_ip_country(date)
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country: #{e}"
end

Using the db_ip_country_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> db_ip_country_with_http_info(date)

begin
  # IP to Country Snapshot
  data, status_code, headers = api_instance.db_ip_country_with_http_info(date)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
date Date

Return type

File

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

db_ip_country_status

db_ip_country_status

IP to Country Snapshot Status

IP to Country Snapshot Status. Returns the file/snapshot described by this operation.

Examples

require 'time'
require 'whoisfreaks'
# setup authorization
WhoisFreaks.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['apiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['apiKey'] = 'Bearer'
end

api_instance = WhoisFreaks::DatabasesIPGeolocationApi.new

begin
  # IP to Country Snapshot Status
  result = api_instance.db_ip_country_status
  p result
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_status: #{e}"
end

Using the db_ip_country_status_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> db_ip_country_status_with_http_info

begin
  # IP to Country Snapshot Status
  data, status_code, headers = api_instance.db_ip_country_status_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SnapshotStatus>
rescue WhoisFreaks::ApiError => e
  puts "Error when calling DatabasesIPGeolocationApi->db_ip_country_status_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

SnapshotStatus

Authorization

ApiKeyAuth

HTTP request headers

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