LogoLogo
Nimble HomeLoginCreate an Account
  • Home
  • Quick Start Tutorials
    • Tutorial Library
      • Track SEO and SEM Ranking
      • Reddit as a Guerilla Marketing Strategy
  • Nimble Platform
    • Nimble Platform Overview
    • Online Pipelines
      • Supermarkets
        • ASDA
        • Tesco Groceries
        • Sainsbury’s
        • Morrisons
      • eCommerce
      • Restaurants
        • Yelp
        • Tabelog
        • Uber Eats Japan
        • Demaecan
        • Uber Eats US
      • Real Estate
        • Zillow
  • Nimble SDK
    • SDK Overview
    • Web API
      • Web API Overview
      • API Product Specs
      • Nimble Web API Quick Start Guide
        • Introduction
        • Nimble APIs Authentication
        • Real-time URL request
        • Delivery methods
        • Batch processing
        • Response codes
        • FAQs
      • Nimble Web API Functions
        • Realtime, Async & Batch Request
        • Geo Location Targeting
        • Javascript Rendering
        • Page Interaction
          • Wait (delay)
          • Wait for Selector
          • Wait and Click
          • Wait and Type
          • Scroll
          • Scroll to
          • Infinite Scrolling
          • Capturing Screenshots
          • Collecting Cookies
          • Executing HTTP Requests
          • Operation Reference
        • Network Capture
          • Filter by URL Matching
          • Filter By Resource Type
            • Real World Demo: Capturing Ajax Requests
          • Wait for Requests
          • Capturing XHR without Rendering
          • Operation Reference
        • Data Parsing
          • Parsing Templates
          • Merge Dynamic Parser
        • Custom Headers & Cookies
        • General Params
      • Vertical Endpoints
        • SERP API
          • Real-time search request
          • Getting local data
          • Browsing SERP pagination
          • Delivery methods
          • Batch Processing
          • Endpoints and Response Codes
        • Maps API
          • Searching for places
          • Getting information about a place
          • Collecting reviews
          • Delivery methods
          • Batch processing
          • Endpoints and Response Codes
    • Web Retrieval API
      • Web Retrieval API Overview
    • Proxy API
      • Nimble IP Overview
      • Nimble IP Quick Start Guide
        • Send a request
        • Nimble IP Autentication
        • Geotargeting and session control
        • Response codes
        • FAQs
      • Nimble IP Functions
        • Country/state/city geotargeting
        • Controlling IP rotation
        • Geo-sessions: longer, stickier, more accurate sessions
        • Using IPv6 Proxies
        • Response Codes
      • Integration Guides
        • Incogniton
        • Kameleo
        • VMLogin
        • AdsPower
        • FoxyProxy
        • Android
        • Multilogin
        • iOS
        • SwitchyOmega
        • Windows
        • macOS
        • Proxifier
        • MuLogin
        • Puppeteer
        • Selenium
        • Scrapy
    • Client Libraries
      • Installation
      • Quick Start
    • LangChain Integration
  • Technologies
    • Browserless Drivers
      • API Driver-Based Pricing
    • IP Optimization Models
    • AI Parsing Skills
  • Management Tools
    • Nimble Dashboard
      • Exploring the User Dashboard
      • Managing Pipelines
      • Reporting and Analytics
      • Account Settings
      • Experimenting with the Playground
      • Billing and history
    • Nimble Admin API
      • Admin API basics
      • Admin API reference
  • General
    • Onboarding Guide
      • Getting started with Nimble's User Dashboard
      • Nimble IP Basics
      • Nimble API Basics
      • Helpful Resources
    • FAQs
      • Account Settings and Security
      • Billing and Pricing
      • Tools and Integrations
      • Nimble API
      • Nimble IP
    • Deprecated APIs
      • E-commerce API
        • E-commerce API Authentication
        • Real-time product request
        • Real-time product search request
        • Delivery methods
        • Batch Processing
        • Endpoints and Response Codes
      • Unlocker Proxy Overview
        • Unlocker Proxy Quick Start Guide
          • Real-time request
          • FAQs
        • Unlocker Proxy FAQ
Powered by GitBook
On this page
  • What?
  • Why?
  • Additional Information
  • Request Option
  • Example Request
  1. Nimble SDK
  2. Web API
  3. Nimble Web API Functions

Geo Location Targeting

PreviousRealtime, Async & Batch RequestNextJavascript Rendering

Last updated 8 months ago

What?

Geo-targeting is the ability to route requests through proxies located in specific geographical locations. This capability is particularly valuable for data collection that varies based on the user's geographic location, which can be crucial for businesses that require localized content or need to adhere to regional regulations and settings at scale.

Geo-targeting is an actual feature of Nimble IP, but it is exposed via Nimble API

Why?

Built on top Nimble IP our premium Residential Proxy product offering, with high reputation, fast performance, and high availability worldwide to ensure requests always get through and are never rate limited. Nimble's Proxy help users with:

  • Geo-Restrictions: Some businesses only operate in certain countries, or may localize information by the user's locale. Nimble AI Browser again uses residential proxies to empower users to send requests for anywhere in the world - ensuring access and localized data accuracy.

  • SEO and Market Research: Companies can see how their or competitors’ websites appear in different regions, which is crucial for strategies involving search engine optimization (SEO) and localized marketing analysis.

  • Unlocking: Helps in mimicking the behavior of local users, reducing the likelihood of being blocked by the target websites which might have anti-scraping measures in place.

Additional Information

  • Supported by real-time, asynchronous, and batch requests.

Request Option

Parameter
Required
Description

url

Required (In case of Web API Endpoint)

URL | The page or resource to be fetched. Note: when using a URL with a query string, encode the URL and place it at the end of the query string - Web API endpoint.

country

Optional (default = all)

String | Country used to access the target URL, use ISO Alpha-2 Country Codes i.e. US, DE, GB

state

Optional (default = null)

String | State used to access the target URL, use ISO Alpha-2 Country Codes i.e. NY, AZ, CA

city

Optional (default = null)

String | City used to access the target URL, use ISO Alpha-2 Country Codes i.e. brooklyn, paris, london

locale

Optional (default = en-US)

String | LCID standard locale used for the URL request. Alternatively, user can use auto for automatic locale based on geo-location.

If no peers are available in a supported country/state/city, Nimble IP will return a 525 response.

Example Request

A simple real-time request with state targeting and locale set to EN, meaning the request will be routed from New York State and the LCID standard will be set to English (which is the default value).

curl -X POST 'https://api.webit.live/api/v1/realtime/web' \
--header 'Authorization: Basic <credential string>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://ipinfo.io/json",
    "country": "US",
    "render":true,
    "state": "NY",
    "locale": "en-US"
}'

Targeting a state is only available when the country parameter is set to US.

Supported endpoints: , , and .

Not supported endpoints: .

You can retrieve a comprehensive list of supported countries, states, and cities by using the of the Admin API.

See the full list of

Web
SERP
Maps
eCommerce
Social
/location/cities endpoint
ISO 3166 alpha-2 country codes