API Access Key & Authentication

After creating an account, you will be assigned an API access key, a unique 32-character hash that allows you to authenticate with the IPAPI interface. To do this, simply append your API access key to the API's base URL using the access_key parameter.

Sign Up to Run API Request

https://api.ipapi.com/api/161.185.160.93\n    ? access_key = YOUR_ACCESS_KEY

Keep your API access key safe: Your API access key is private and should at no time be shown publicly. You can reset it with immediate effect using your account dashboard at any given time.

API Response

Following a successful API request, the API will return more than 40 unique response objects containing result data. An API response can be returned in JSON or XML format and is structured into 4 modules: General information, location data, time zone data, currency data, connection data and security data. Response objects contained in each module will be explained in detail in the API Response Objects section.

Find below an example API response for an IPv4 address in Brooklyn, New York.

Example API Response:

{\n    \"ip\": \"161.185.160.93\",\n    \"type\": \"ipv4\",\n    \"continent_code\": \"NA\",\n    \"continent_name\": \"North America\",\n    \"country_code\": \"US\",\n    \"country_name\": \"United States\",\n    \"region_code\": \"NY\",\n    \"region_name\": \"New York\",\n    \"city\": \"Bath Beach\",\n    \"zip\": \"11201\",\n    \"latitude\": 40.69459915161133,\n    \"longitude\": -73.99063873291016,\n    \"msa\": \"35620\",\n    \"dma\": \"501\",\n    \"radius\": 30.012950897216797,\n    \"ip_routing_type\": \"fixed\",\n    \"connection_type\": \"tx\",\n    \"location\": {\n        \"geoname_id\": 5108111,\n        \"capital\": \"Washington D.C.\",\n        \"languages\": [\n            {\n                \"code\": \"en\",\n                \"name\": \"English\",\n                \"native\": \"English\"\n            }\n        ],\n        \"country_flag\": \"http://assets.ipapi.com/flags/us.svg\",\n        \"country_flag_emoji\": \"🇺🇸\",\n        \"country_flag_emoji_unicode\": \"U+1F1FA U+1F1F8\",\n        \"calling_code\": \"1\",\n        \"is_eu\": false\n    },\n    \"time_zone\": {\n        \"id\": \"America/New_York\",\n        \"current_time\": \"2018-09-24T05:07:10-04:00\",\n        \"gmt_offset\": -14400,\n        \"code\": \"EDT\",\n        \"is_daylight_saving\": true\n    },\n    \"currency\": {\n        \"code\": \"USD\",\n        \"name\": \"US Dollar\",\n        \"plural\": \"US dollars\",\n        \"symbol\": \"$\",\n        \"symbol_native\": \"$\"\n    },\n    \"connection\": {\n        \"asn\": 22252,\n        \"isp\": \"The City of New York\",\n        \"sld\": \"nyc\",\n        \"tld\": \"gov\",\n        \"carrier\": \"the city of new york\",\n        \"home\": false,\n        \"organization_type\": \"Government (Municipal)\",\n        \"isic_code\": \"O8411\",\n        \"naics_code\": \"009211\"\n    },\n    \"security\": {\n        \"is_proxy\": null,\n        \"proxy_type\": null,\n        \"is_crawler\": false,\n        \"crawler_name\": null,\n        \"crawler_type\": null,\n        \"is_tor\": false,\n        \"threat_level\": \"low\",\n        \"threat_types\": null,\n        \"proxy_last_detected\": null,\n        \"proxy_level\": null,\n        \"vpn_service\": null,\n        \"anonymizer_status\": null,\n        \"hosting_facility\": false\n    }\n}

Please note: To be able to show you a comprehensive API response, Hostname and Security data have been included in the result above. To enable this data in your API response, please follow the instructions in the Hostname Lookup and Security Data sections of this documentation.

API Endpoints

The API includes three endpoints, each covering a different type of functionality. Please find below a quick overview, and click any endpoint to learn more about its usage.

Standard Lookup
Look up any given IP address.
Bulk Lookup
Look up multiple IP addresses in bulk.
Origin Lookup
Look up the IP address from which the current API request is coming.

256-bit HTTPS Encryption

You can connect to the API using industry standard HTTPS (SSL) by appending an \" s \" to the HTTP Protocol. You can see an example API request using HTTPS below.

Example API Request:

https://api.ipapi.com/api/161.185.160.93

JSONP Callbacks

The API supports JSONP Callbacks. To make use of this feature, simply append the API's callback parameter to your API request URL and set it to your preferred function name. The API will then return your API results set wrapped inside the tags of the function you specified.

Example API Request:

Sign Up to Run API Request

https://api.ipapi.com/api/161.185.160.93\n    ? access_key = YOUR_ACCESS_KEY\n    & callback = FUNCTION_NAME\n

Example API Response:

CALLBACK_FUNCTION ({\n    {\n        \"ip\": \"161.185.160.93\",\n        \"hostname\": \"161.185.160.93\",\n        \"type\": \"ipv4\",\n        \"continent_code\": \"NA\",\n        \"continent_name\": \"North America\",\n        \"country_code\": \"US\",\n        \"country_name\": \"United States\",\n        \"region_code\": \"NY\",\n        [...]\n    }\n})\n

Please note: The API also supports Access-Control (CORS) headers.

API Error Codes

If your API request fails for any reason, the API will return a JSON error message detailing the error that occurred. As an example, find below the error the API returns when the monthly API request limit is reached.

Example Error:

{\n    \"success\": false,\n    \"error\": {\n        \"code\": 104,\n        \"type\": \"monthly_limit_reached\",\n        \"info\": \"Your monthly API request volume has been reached. Please upgrade your plan.\"\n    }\n}

Common API Errors:

Code	Type	Info
`404`	`404_not_found`	User requested a resource which does not exist.
`101`	`missing_access_key`	User did not supply an access key.
`101`	`invalid_access_key`	User supplied an invalid access key.
`102`	`inactive_user`	User account is inactive or blocked.
`103`	`invalid_api_function`	User requested a non-existent API function.
`104`	`usage_limit_reached`	User has reached his subscription's monthly request allowance.
`105`	`function_access_restricted`	The user's current subscription does not support this API function.
`106`	`invalid_ip_address`	The IP Address supplied is invalid
`301`	`invalid_fields`	User specified one or more invalid fields inside the `fields` parameter.
`302`	`too_many_ips`	User specified too many IP addresses in a single Bulk Lookup request.
`303`	`batch_not_supported_on_plan`	The user's current subscription plan does not support Bulk Lookup.

Chat with APILayer´s team on Discord.

\n\n\n\n \n Questions? \n \n Contact Sales\n .\n\n

\n\n\n\n \n Need help? \n \n Contact Support\n .\n\n

\n\n \n\n \n

","contentUpdatedAt","Mon, 23 Mar 2026 16:54:53 GMT","generatorLanguages","SHUBApiDetails","exploreUrl","currentToc",{"_69":231,"_232":244,"_225":245,"_235":246,"_160":520},[],"shubUrl","apiRenderer","TOGGLE","routingSettings",{"_526":527,"_528":19},"routing","browser","credentialsEnabled","isTemplatePreview","metaInfo",{"_532":533,"_204":205,"_225":534},"canonicalUrl","https://docs.apilayer.com/ipapi/docs/getting-started","Getting Started | IPAPI | APILayer ","actionData","errors"]