{ "openapi": "3.0.0", "info": { "title": "Ip Geo Location", "description": "Get geo data from given IP address", "version": "1.0.0" }, "servers": [ { "url": "https://ipgeolocation.aqio.xyz", "description": "API over HTTPS" } ], "paths": { "/api/asn": { "get": { "tags": [ "asn" ], "summary": "/api/asn", "description": "Returns the Asn data for the current IP address", "operationId": "get_ip_geo_location_asn_index", "responses": { "200": { "description": "Returns the ASN data for the current IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asn" } } } } } } } }, "/api/asn/{ip}": { "get": { "tags": [ "asn" ], "summary": "/api/asn/{ip}", "description": "Returns the Asn data for the given IP address", "operationId": "get_ip_geo_location_asn_by_ip", "parameters": [ { "name": "ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the ASN data for the given IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Asn" } } } } } } } }, "/api/city": { "get": { "tags": [ "city" ], "summary": "/api/city", "description": "Returns the City data for the current IP address", "operationId": "get_ip_geo_location_city_index", "responses": { "200": { "description": "Returns the City data for the current IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } } } } } } }, "/api/city/{ip}": { "get": { "tags": [ "city" ], "summary": "/api/city/{ip}", "description": "Returns the City data for the given IP address", "operationId": "get_ip_geo_location_city_by_ip", "parameters": [ { "name": "ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the City data for the given IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } } } } } } }, "/api/country": { "get": { "tags": [ "country" ], "summary": "/api/country", "description": "Returns the Country data for the current IP address", "operationId": "get_ip_geo_location_country_index", "responses": { "200": { "description": "Returns the Country data for the current IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } } }, "/api/country/{ip}": { "get": { "tags": [ "country" ], "summary": "/api/country/{ip}", "description": "Returns the Country data for the given IP address", "operationId": "get_ip_geo_location_country_by_ip", "parameters": [ { "name": "ip", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Country data for the given IP address", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } } } }, "components": { "schemas": { "Asn": { "required": [ "ipAddress", "network" ], "properties": { "autonomousSystemNumber": { "title": "the autonomous system number\nassociated with the IP address", "type": "integer", "nullable": true }, "autonomousSystemOrganization": { "title": "the organization\nassociated with the registered autonomous system number for the IP\naddress", "type": "string", "nullable": true }, "ipAddress": { "title": "the IP address that the data in the model is\nfor", "type": "string" }, "network": { "title": "The network in CIDR notation associated with\nthe record. In particular, this is the largest network where all of the\nfields besides $ipAddress have the same value.", "type": "string" } }, "type": "object" }, "City": { "required": [ "city", "location", "mostSpecificSubdivision", "postal", "subdivisions", "continent", "country", "maxmind", "registeredCountry", "representedCountry", "traits" ], "properties": { "city": { "$ref": "#/components/schemas/City2" }, "location": { "$ref": "#/components/schemas/Location" }, "mostSpecificSubdivision": { "$ref": "#/components/schemas/Subdivision" }, "postal": { "$ref": "#/components/schemas/Postal" }, "subdivisions": { "title": "An array of \\GeoIp2\\Record\\Subdivision\nobjects representing the country subdivisions for the requested IP\naddress. The number and type of subdivisions varies by country, but a\nsubdivision is typically a state, province, county, etc. Subdivisions\nare ordered from most general (largest) to most specific (smallest).\nIf the response did not contain any subdivisions, this method returns\nan empty array.", "type": "array", "items": { "$ref": "#/components/schemas/Subdivision" } }, "continent": { "$ref": "#/components/schemas/Continent" }, "country": { "$ref": "#/components/schemas/Country2" }, "maxmind": { "$ref": "#/components/schemas/MaxMind" }, "registeredCountry": { "$ref": "#/components/schemas/Country2" }, "representedCountry": { "$ref": "#/components/schemas/RepresentedCountry" }, "traits": { "$ref": "#/components/schemas/Traits" } }, "type": "object" }, "Country": { "required": [ "continent", "country", "maxmind", "registeredCountry", "representedCountry", "traits" ], "properties": { "continent": { "$ref": "#/components/schemas/Continent" }, "country": { "$ref": "#/components/schemas/Country2" }, "maxmind": { "$ref": "#/components/schemas/MaxMind" }, "registeredCountry": { "$ref": "#/components/schemas/Country2" }, "representedCountry": { "$ref": "#/components/schemas/RepresentedCountry" }, "traits": { "$ref": "#/components/schemas/Traits" } }, "type": "object" }, "City2": { "required": [ "names" ], "properties": { "confidence": { "title": "A value from 0-100 indicating MaxMind's\nconfidence that the location level is correct. This attribute is only available\nfrom the Insights service and the GeoIP2 Enterprise database.", "type": "integer", "nullable": true }, "geonameId": { "title": "The GeoName ID for the location level. This attribute\nis returned by all location services and databases.", "type": "integer", "nullable": true }, "name": { "title": "The name based on the locales list\npassed to the constructor. This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "names": { "title": "An array map where the keys are locale codes\nand the values are names. This attribute is returned by all location\nservices and databases.", "type": "array", "items": {} } }, "type": "object" }, "Location": { "properties": { "averageIncome": { "title": "The average income in US dollars\nassociated with the requested IP address. This attribute is only available\nfrom the Insights service.", "type": "integer", "nullable": true }, "accuracyRadius": { "title": "The approximate accuracy radius in\nkilometers around the latitude and longitude for the IP address. This is\nthe radius where we have a 67% confidence that the device using the IP\naddress resides within the circle centered at the latitude and longitude\nwith the provided radius.", "type": "integer", "nullable": true }, "latitude": { "title": "The approximate latitude of the location\nassociated with the IP address. This value is not precise and should not be\nused to identify a particular address or household.", "type": "number", "format": "float", "nullable": true }, "longitude": { "title": "The approximate longitude of the location\nassociated with the IP address. This value is not precise and should not be\nused to identify a particular address or household.", "type": "number", "format": "float", "nullable": true }, "metroCode": { "title": "The metro code of the location if the location\nis in the US. MaxMind returns the same metro codes as the\nGoogle AdWords API. See\nhttps://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.", "type": "integer", "nullable": true }, "populationDensity": { "title": "The estimated population per square\nkilometer associated with the IP address. This attribute is only available\nfrom the Insights service.", "type": "integer", "nullable": true }, "timeZone": { "title": "The time zone associated with location, as\nspecified by the IANA Time Zone Database, e.g., \"America/New_York\". See\nhttps://www.iana.org/time-zones.", "type": "string", "nullable": true } }, "type": "object" }, "Subdivision": { "required": [ "names" ], "properties": { "isoCode": { "title": "This is a string up to three characters long\ncontain the subdivision portion of the ISO 3166-2 code. See\nhttps://en.wikipedia.org/wiki/ISO_3166-2. This attribute is returned by all\nlocation databases and services except Country.", "type": "string", "nullable": true }, "confidence": { "title": "A value from 0-100 indicating MaxMind's\nconfidence that the location level is correct. This attribute is only available\nfrom the Insights service and the GeoIP2 Enterprise database.", "type": "integer", "nullable": true }, "geonameId": { "title": "The GeoName ID for the location level. This attribute\nis returned by all location services and databases.", "type": "integer", "nullable": true }, "name": { "title": "The name based on the locales list\npassed to the constructor. This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "names": { "title": "An array map where the keys are locale codes\nand the values are names. This attribute is returned by all location\nservices and databases.", "type": "array", "items": {} } }, "type": "object" }, "Postal": { "properties": { "code": { "title": "The postal code of the location. Postal codes\nare not available for all countries. In some countries, this will only\ncontain part of the postal code. This attribute is returned by all location\ndatabases and services besides Country.", "type": "string", "nullable": true }, "confidence": { "title": "A value from 0-100 indicating MaxMind's\nconfidence that the postal code is correct. This attribute is only\navailable from the Insights service and the GeoIP2 Enterprise\ndatabase.", "type": "integer", "nullable": true } }, "type": "object" }, "Continent": { "required": [ "names" ], "properties": { "code": { "title": "A two character continent code like \"NA\" (North\nAmerica) or \"OC\" (Oceania). This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "geonameId": { "title": "The GeoName ID for the continent. This\nattribute is returned by all location services and databases.", "type": "integer", "nullable": true }, "name": { "title": "The name based on the locales list\npassed to the constructor. This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "names": { "title": "An array map where the keys are locale codes\nand the values are names. This attribute is returned by all location\nservices and databases.", "type": "array", "items": {} } }, "type": "object" }, "Country2": { "required": [ "isInEuropeanUnion", "names" ], "properties": { "isInEuropeanUnion": { "title": "This is true if the country is a\nmember state of the European Union. This attribute is returned by all\nlocation services and databases.", "type": "boolean" }, "isoCode": { "title": "The two-character ISO 3166-1 alpha code\nfor the country. See https://en.wikipedia.org/wiki/ISO_3166-1. This\nattribute is returned by all location services and databases.", "type": "string", "nullable": true }, "confidence": { "title": "A value from 0-100 indicating MaxMind's\nconfidence that the location level is correct. This attribute is only available\nfrom the Insights service and the GeoIP2 Enterprise database.", "type": "integer", "nullable": true }, "geonameId": { "title": "The GeoName ID for the location level. This attribute\nis returned by all location services and databases.", "type": "integer", "nullable": true }, "name": { "title": "The name based on the locales list\npassed to the constructor. This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "names": { "title": "An array map where the keys are locale codes\nand the values are names. This attribute is returned by all location\nservices and databases.", "type": "array", "items": {} } }, "type": "object" }, "MaxMind": { "properties": { "queriesRemaining": { "title": "the number of remaining queries you\nhave for the service you are calling", "type": "integer", "nullable": true } }, "type": "object" }, "RepresentedCountry": { "required": [ "isInEuropeanUnion", "names" ], "properties": { "type": { "title": "A string indicating the type of entity that is\nrepresenting the country. Currently we only return military\nbut this could expand to include other types in the future.", "type": "string", "nullable": true }, "isInEuropeanUnion": { "title": "This is true if the country is a\nmember state of the European Union. This attribute is returned by all\nlocation services and databases.", "type": "boolean" }, "isoCode": { "title": "The two-character ISO 3166-1 alpha code\nfor the country. See https://en.wikipedia.org/wiki/ISO_3166-1. This\nattribute is returned by all location services and databases.", "type": "string", "nullable": true }, "confidence": { "title": "A value from 0-100 indicating MaxMind's\nconfidence that the location level is correct. This attribute is only available\nfrom the Insights service and the GeoIP2 Enterprise database.", "type": "integer", "nullable": true }, "geonameId": { "title": "The GeoName ID for the location level. This attribute\nis returned by all location services and databases.", "type": "integer", "nullable": true }, "name": { "title": "The name based on the locales list\npassed to the constructor. This attribute is returned by all location\nservices and databases.", "type": "string", "nullable": true }, "names": { "title": "An array map where the keys are locale codes\nand the values are names. This attribute is returned by all location\nservices and databases.", "type": "array", "items": {} } }, "type": "object" }, "Traits": { "required": [ "isAnonymous", "isAnonymousVpn", "isAnycast", "isHostingProvider", "isLegitimateProxy", "isPublicProxy", "isResidentialProxy", "isTorExitNode" ], "properties": { "autonomousSystemNumber": { "title": "The autonomous system number\nassociated with the IP address. See\nhttps://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This attribute\nis only available from the City Plus and Insights web services and the\nGeoIP2 Enterprise database.", "type": "integer", "nullable": true }, "autonomousSystemOrganization": { "title": "The organization\nassociated with the registered autonomous system number for the IP address.\nSee https://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This\nattribute is only available from the City Plus and Insights web services and\nthe GeoIP2 Enterprise database.", "type": "string", "nullable": true }, "connectionType": { "title": "The connection type may take the\nfollowing values: \"Dialup\", \"Cable/DSL\", \"Corporate\", \"Cellular\", and\n\"Satellite\". Additional values may be added in the future. This attribute is\nonly available from the City Plus and Insights web services and the GeoIP2\nEnterprise database.", "type": "string", "nullable": true }, "domain": { "title": "The second level domain associated with the\nIP address. This will be something like \"example.com\" or \"example.co.uk\",\nnot \"foo.example.com\". This attribute is only available from the\nCity Plus and Insights web services and the GeoIP2 Enterprise\ndatabase.", "type": "string", "nullable": true }, "ipAddress": { "title": "The IP address that the data in the model\nis for. If you performed a \"me\" lookup against the web service, this\nwill be the externally routable IP address for the system the code is\nrunning on. If the system is behind a NAT, this may differ from the IP\naddress locally assigned to it. This attribute is returned by all end\npoints.", "type": "string", "nullable": true }, "isAnonymous": { "title": "This is true if the IP address belongs to\nany sort of anonymous network. This property is only available from GeoIP2\nInsights.", "type": "boolean" }, "isAnonymousVpn": { "title": "This is true if the IP address is\nregistered to an anonymous VPN provider. If a VPN provider does not register\nsubnets under names associated with them, we will likely only flag their IP\nranges using the isHostingProvider property. This property is only available\nfrom GeoIP2 Insights.", "type": "boolean" }, "isAnycast": { "title": "This is true if the IP address belongs to an [anycast\nnetwork](https://en.wikipedia.org/wiki/Anycast). This property is not\navailable from GeoLite databases or web services.", "type": "boolean" }, "isHostingProvider": { "title": "This is true if the IP address belongs\nto a hosting or VPN provider (see description of isAnonymousVpn property).\nThis property is only available from GeoIP2 Insights.", "type": "boolean" }, "isLegitimateProxy": { "title": "This attribute is true if MaxMind\nbelieves this IP address to be a legitimate proxy, such as an internal\nVPN used by a corporation. This attribute is only available in the GeoIP2\nEnterprise database.", "type": "boolean" }, "isPublicProxy": { "title": "This is true if the IP address belongs to\na public proxy. This property is only available from GeoIP2 Insights.", "type": "boolean" }, "isResidentialProxy": { "title": "This is true if the IP address is\non a suspected anonymizing network and belongs to a residential ISP. This\nproperty is only available from GeoIP2 Insights.", "type": "boolean" }, "isTorExitNode": { "title": "This is true if the IP address is a Tor\nexit node. This property is only available from GeoIP2 Insights.", "type": "boolean" }, "isp": { "title": "The name of the ISP associated with the IP\naddress. This attribute is only available from the City Plus and Insights\nweb services and the GeoIP2 Enterprise database.", "type": "string", "nullable": true }, "mobileCountryCode": { "title": "The [mobile country code\n(MCC)](https://en.wikipedia.org/wiki/Mobile_country_code) associated with\nthe IP address and ISP. This property is available from the City Plus and\nInsights web services and the GeoIP2 Enterprise database.", "type": "string", "nullable": true }, "mobileNetworkCode": { "title": "The [mobile network code\n(MNC)](https://en.wikipedia.org/wiki/Mobile_country_code) associated with\nthe IP address and ISP. This property is available from the City Plus and\nInsights web services and the GeoIP2 Enterprise database.", "type": "string", "nullable": true }, "network": { "title": "The network in CIDR notation associated with\nthe record. In particular, this is the largest network where all of the\nfields besides $ipAddress have the same value.", "type": "string", "nullable": true }, "organization": { "title": "The name of the organization\nassociated with the IP address. This attribute is only available from the\nCity Plus and Insights web services and the GeoIP2 Enterprise database.", "type": "string", "nullable": true }, "staticIpScore": { "title": "An indicator of how static or\ndynamic an IP address is. This property is only available from GeoIP2\nInsights.", "type": "number", "format": "float", "nullable": true }, "userCount": { "title": "The estimated number of users sharing\nthe IP/network during the past 24 hours. For IPv4, the count is for the\nindividual IP. For IPv6, the count is for the /64 network. This property is\nonly available from GeoIP2 Insights.", "type": "integer", "nullable": true }, "userType": { "title": "

The user type associated with the IP\naddress. This can be one of the following values:

business\n
cafe\n
cellular\n
college\n
consumer_privacy_network\n
content_delivery_network\n
dialup\n
government\n
hosting\n
library\n
military\n
residential\n
router\n
school\n
search_engine_spider\n
traveler\n

\nThis attribute is only available from the Insights web service and the\nGeoIP2 Enterprise database.\n

", "type": "string", "nullable": true } }, "type": "object" } } } }