{"id":18376,"date":"2021-04-28T09:22:51","date_gmt":"2021-04-28T09:22:51","guid":{"rendered":"http:\/\/wiki2.plumserver.com\/?post_type=ht_kb&p=18376"},"modified":"2026-03-12T03:37:16","modified_gmt":"2026-03-12T07:37:16","slug":"magento-2-ip-geolocation-lookup-v1-x-rest-api-reference","status":"publish","type":"post","link":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api","title":{"rendered":"Magento 2 IP Geolocation Lookup v1.x REST API Reference"},"content":{"rendered":"\n

GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module<\/a> using the REST API. To access the REST API, you need to take the following steps:<\/p>\n\n\n\n

Step 1. Open Access to the API<\/h2>\n\n\n\n
  1. In the Magento backend main menu, go to System > Extensions > Integrations > New Integration > API<\/strong>.<\/li>
  2. Select Plumrocket <\/strong>> IP Geolocation Lookup<\/strong>. <\/li>
  3. Save changes.<\/li>
  4. Flush cache.<\/li><\/ol>\n\n\n\n
    \"\"\/<\/figure>\n\n\n\n
    \n

    Step 2. Make a GET Request to the API on IP address<\/h2>\n\n\n\n
    URL http:\/\/www.YourSite.com<\/mark>\/rest\/V1\/prgeoiplookup\/8.8.8.8<\/mark>.<\/pre>\n\n\n\n
    8.8.8.8<\/em><\/mark> is an IP address from which we want to retrieve data.
    www.YourSite.com<\/em><\/mark> is your website’s IP address.<\/p>\n\n\n\n
    By default, the data will be returned in XML format. To get JSON, you need to specify the data type \u201capplication\/json\u201d in the request header.<\/p>\n<\/div><\/div>\n\n\n\n
    Example 1. Return all available information of an IP address using REST API. Data type in response – XML<\/h3>\n\n\n\n
    As an example, we use the 8.8.8.8 IP address:<\/p>\n\n\n\n
    <\/div>
    GET http:\/\/www.YourSite.com\/rest\/V1\/prgeoiplookup\/8.8.8.8\/<\/code><\/pre><\/div>\n\n\n\n
    Request Headers:<\/p>\n\n\n\n
    GET \/rest\/V1\/prgeoiplookup\/8.8.8.8\nHost: www.YourSite.com<\/mark>\nAccept: *\/*\nUser-Agent: Mozilla\/5.0 (compatible; Rigor\/1.0.0; http:\/\/rigor.com)<\/pre>\n\n\n\n
    Response Body:<\/p>\n\n\n\n
    <\/div>
    <response>\n\t<item>\n\t\t<latitude>37.7510<\/latitude>\n\t\t<longitude>-97.8220<\/longitude>\n\t\t<continent_code>NA<\/continent_code>\n\t\t<continent_name>North America<\/continent_name>\n\t\t<country_code>US<\/country_code>\n\t\t<country_name>United States<\/country_name>\n\t\t<is_in_european_union>false<\/is_in_european_union>\n\t\t<database_name>Maxmind<\/database_name>\n\t<\/item>\n<\/response><\/code><\/pre><\/div>\n\n\n\n
    Example 2. Return all available information of an IP address using REST API. Data type in response – JSON<\/h3>\n\n\n\n
    As an example, we use the 8.8.8.8 IP address:<\/p>\n\n\n\n
    <\/div>
    GET http:\/\/www.YourSite.com\/rest\/V1\/prgeoiplookup\/8.8.8.8\/<\/code><\/pre><\/div>\n\n\n\n
    Request Headers:<\/p>\n\n\n\n
    GET \/rest\/V1\/prgeoiplookup\/8.8.8.8\nHost: www.YourSite.com<\/mark>\nAccept: *\/*\nUser-Agent: Mozilla\/5.0 (compatible; Rigor\/1.0.0; http:\/\/rigor.com)\nContent-Type: application\/json<\/pre>\n\n\n\n
    Response Body:<\/p>\n\n\n\n
    <\/div>
    [{\"latitude\":\"37.7510\",\"longitude\":\"-97.8220\",\"continent_code\":\"NA\",\"continent_name\":\"North America\",\"country_code\":\"US\",\"country_name\":\"United States\",\"is_in_european_union\":false,\"database_name\":\"Maxmind\"}]<\/code><\/pre><\/div>\n\n\n\n
    In the REST API request, you can also specify the priority of using databases. By default, the sequence is as follows: Maxmind, IpToCountry, IpApi. In the REST API link, the services are specified after the IP parameter and are separated by commas (see Example 3).<\/p>\n\n\n\n
    Example 3. Return all available information of an IP address using REST API and specifying the priority of using services<\/h3>\n\n\n\n
    As an example, we use the 8.8.8.8 IP address:<\/p>\n\n\n\n
    <\/div>
    GET http:\/\/www.YourSite.com\/rest\/V1\/prgeoiplookup\/8.8.8.8\/ipapi,maxmind,iptocountry\/<\/code><\/pre><\/div>\n\n\n\n
    Request Headers:<\/p>\n\n\n\n
    GET \/rest\/V1\/prgeoiplookup\/8.8.8.8\/ipapi,maxmind,iptocountry\/\nHost: www.YourSite.com\nAccept: *\/*\nUser-Agent: Mozilla\/5.0 (compatible; Rigor\/1.0.0; http:\/\/rigor.com)<\/pre>\n\n\n\n
    Response Body:<\/p>\n\n\n\n
    <\/div>
    <response>\n\t<item>\n\t\t<country_code>US<\/country_code>\n\t\t<country_name>United States<\/country_name>\n\t\t<latitude>37.751<\/latitude>\n\t\t<longitude>-97.822<\/longitude>\n\t\t<database_name>Ipapi.Com<\/database_name>\n\t\t<is_in_european_union>false<\/is_in_european_union>\n\t<\/item>\n<\/response><\/code><\/pre><\/div>\n\n\n\n
    You can also specify more than one service after the IP parameter when making a REST API request<\/strong>:<\/p>\n\n\n\n
    Let’s only use the ipapi service in the following request example:<\/p>\n\n\n\n
    <\/div>
    GET http:\/\/www.YourSite.com\/rest\/V1\/prgeoiplookup\/8.8.8.8\/ipapi\/<\/code><\/pre><\/div>\n\n\n\n
    Let’s use ipapi and IpToCountry services in the following request example:<\/p>\n\n\n\n
    <\/div>
    GET http:\/\/www.YourSite.com\/rest\/V1\/prgeoiplookup\/8.8.8.8\/ipapi,iptocountry\/<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"
    GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you need to take the following steps: Step 1. Open Access to the API In the Magento backend main menu, go to System > Extensions > Integrations > New … <\/p>\n
    Continue reading “Magento 2 IP Geolocation Lookup v1.x REST API Reference”<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"_mi_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0},"categories":[200],"tags":[],"yoast_head":"\nMagento 2 IP Geolocation Lookup v1.x REST API Reference - Plumrocket Documentation<\/title>\n<meta name=\"description\" content=\"GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Magento 2 IP Geolocation Lookup v1.x REST API Reference\" \/>\n<meta property=\"og:description\" content=\"GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you\" \/>\n<meta property=\"og:url\" content=\"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api\" \/>\n<meta property=\"og:site_name\" content=\"Plumrocket Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2021-04-28T09:22:51+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-03-12T07:37:16+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Plumrocket\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Magento 2 IP Geolocation Lookup v1.x REST API Reference - Plumrocket Documentation","description":"GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api","og_locale":"en_US","og_type":"article","og_title":"Magento 2 IP Geolocation Lookup v1.x REST API Reference","og_description":"GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you","og_url":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api","og_site_name":"Plumrocket Documentation","article_published_time":"2021-04-28T09:22:51+00:00","article_modified_time":"2026-03-12T07:37:16+00:00","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Plumrocket","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebSite","@id":"https:\/\/plumrocket.com\/docs\/#website","url":"https:\/\/plumrocket.com\/docs\/","name":"Plumrocket Documentation","description":"Extensions docs, troubleshootings etc.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/plumrocket.com\/docs\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api#webpage","url":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api","name":"Magento 2 IP Geolocation Lookup v1.x REST API Reference - Plumrocket Documentation","isPartOf":{"@id":"https:\/\/plumrocket.com\/docs\/#website"},"datePublished":"2021-04-28T09:22:51+00:00","dateModified":"2026-03-12T07:37:16+00:00","author":{"@id":"https:\/\/plumrocket.com\/docs\/#\/schema\/person\/c96fccdb89342ae6804272265723eca8"},"description":"GeoIP Lookup REST API allows you to integrate your own development with the IP Geolocation Lookup module using the REST API. To access the REST API, you","breadcrumb":{"@id":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide\/rest-api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Magento 2 Extensions","item":"https:\/\/plumrocket.com\/magento-extensions"},{"@type":"ListItem","position":2,"name":"Magento 2 IP Geolocation Lookup","item":"https:\/\/plumrocket.com\/magento-ip-geolocation-lookup"},{"@type":"ListItem","position":3,"name":"Documentation","item":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup"},{"@type":"ListItem","position":4,"name":"v1","item":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1"},{"@type":"ListItem","position":5,"name":"Developer Guide","item":"https:\/\/plumrocket.com\/docs\/magento-ip-geolocation-lookup\/v1\/devguide"},{"@type":"ListItem","position":6,"name":"REST API Reference"}]},{"@type":"Person","@id":"https:\/\/plumrocket.com\/docs\/#\/schema\/person\/c96fccdb89342ae6804272265723eca8","name":"Plumrocket","image":{"@type":"ImageObject","@id":"https:\/\/plumrocket.com\/docs\/#personlogo","inLanguage":"en-US","url":"https:\/\/secure.gravatar.com\/avatar\/10c44aa45aab391250913d982e552e53?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/10c44aa45aab391250913d982e552e53?s=96&d=mm&r=g","caption":"Plumrocket"}}]}},"_links":{"self":[{"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/posts\/18376"}],"collection":[{"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/comments?post=18376"}],"version-history":[{"count":5,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/posts\/18376\/revisions"}],"predecessor-version":[{"id":28958,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/posts\/18376\/revisions\/28958"}],"wp:attachment":[{"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/media?parent=18376"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/categories?post=18376"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/plumrocket.com\/docs\/wp-json\/wp\/v2\/tags?post=18376"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}