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
  • Which API is right for me?
  • Setting Up An API Pipeline
  • Sending Your First Data Request
  • Next Steps
  1. General
  2. Onboarding Guide

Nimble API Basics

PreviousNimble IP BasicsNextHelpful Resources

Last updated 7 months ago

Which API is right for me?

Nimble APIs includes four different APIs - but knowing which one is right for you is easy!

If you're not sure which API is right for you, we recommend starting with the Web API. However, if your use case fits in one of our specialized APIs, we encourage you to explore those as well for more tailored solutions to meet your specific needs.

Setting Up An API Pipeline

By default, you account will come with an out-of-the-box API pipeline. If you prefer to keep things simple, feel free to skip this step and just use that pipeline. However, as your usage expands, pipelines will become more and more useful in organizing, compartmentalizing, and tracking your activity.

To create a new pipeline, follow these steps:

  1. Log in to the User Dashboard.

  2. Go to the "Pipelines" page.

  3. Click "+ Add Pipeline" on the right side of the page.

  4. Enter a name for the pipeline, and select "Nimble API" as the pipeline type in order to use it for data requests, then click "Next".

Your new pipeline is ready to go! On the completion screen you'll receive the pipeline username, password, authentication token, and a "Hello World" request example.

You can always get the pipeline's details again in the pipeline overview page.

Sending Your First Data Request

If you followed along with the previous step, you can copy the "Hello World" example from the pipeline creation confirmation and skip straight ahead to executing your request.

Using the Playground Query Builder

The easiest way to get started with Nimble APIs is to head to the Playground. The Playground features an interactive query builder that can help you learn how to write API requests, and even execute and display the results.

To visit the Playground:

  1. Log in to the User Dashboard.

  2. Click on "Playground" on the left hand side.

At the top of the page, you'll be able to select which Nimble product you'd like to try. By default, Nimble API will already be open.

Next, select the relevant API. If you're not sure which API you need, see "Which API is right for me?" at the top of this page.

On the left hand side, you'll see the parameters and options you can configure, such as the pipeline to use, the URL from which to collect data, Javascript page rendering, parsing, and more. As you make changes, the query builder on the right will automatically highlight and update your sample query in keeping with your changes.

For your first request, we recommend enabling "Page Render" and "Parse". This will execute javascript on the page, ensuring it's fully rendered, and parse the results into a readable format.

Once you've configured your request, click "Run Request" on the bottom right. After a few moments, the page you requested will appear on the bottom left, and the result data on the right.

Congratulations! You just ran your first request.

You can also copy the sample request code that the playground constructed and execute it in your terminal or application.

Sending A Basic cURL request

Sending Nimble API requests is straightforward. Let’s break down a basic cURL request:


curl -X POST '<https://api.webit.live/api/v1/realtime/web>' \\
    -H 'Authorization: Basic <Base64 Token>' \\
    -H 'Content-Type: application/json' \\
--data-raw '{ 
    "url": "<https://www.google.com/search?q=hello> world", 
    "render": false, 
    "parse": false,
    "country": "ALL", 
    "locale": "en"
}'
  • <credential string> - Replace this with your API Pipeline's Base64 Token.

  • url - The target URL you'd like to collect.

  • country - The origin country from which to send the request.

  • render - Execute JS on the requested webpage.

  • parse - Structures the HTML into a machine-readable JSON format.

Next Steps

Nimble's APIs are rich with features! To take your data collection to the next level, we recommend checking out the following resources:

Learn more about the capabilities of Nimble APIs and take your data collection to the next level.

Nimble APIs can deliver data asynchronously to your cloud storage or via push pull.

Nimble's APIs can click, scroll, wait, and perform other interactions with a webpage before returning data.

Group up to 1,000 different requests in a single batch - with fully customizable options for each one.

Web API

Stream Public Web Data from Any URL.

Includes powerful tools such as page interactions, parsing templates, Internal API Network Capture, and more.

SERP API

Seamlessly scrape search engine data.

Specialized for SERPs including Google, Bing, and Yandex, and includes granular localization tools.

Maps API

Capture fresh & rich business data from Maps engines.

Discover businesses in any geographic area, collect in-depth public data about each one, and gather user-generated reviews.

E-commerce API

Gather product data from major E-commerce marketplaces.

Find and collect clean, accurate product data from marketplaces such as Amazon, Walmart, Google Shopping, and more.

Nimble API Quick Start Guide:
Delivery Methods:
Page Interactions:
Batch Processing: