Skip to main content

​
API Reference

Complete reference for the Nimble Web API endpoints and parameters.

​
Base Endpoints

​
Real-time Web API

POST https://api.webit.live/api/v1/realtime/web

​
Async Web API

POST https://api.webit.live/api/v1/async/web

​
Batch Web API

POST https://api.webit.live/api/v1/batch/web

​
Parameters

​
Required Parameters

ParameterTypeDescription
urlStringThe page or resource to be fetched

​
Optional Parameters

ParameterTypeDefaultDescription
methodStringGETHTTP method
parseBooleanfalseParse content to JSON
renderBooleanfalseEnable JavaScript rendering
driverEnumvx6Manual driver selection
formatEnumJSONResponse format (JSON/HTML/JSON-LINES/RAW)
countryStringallCountry for request (ISO Alpha-2)
stateStringnullState for request
cityStringnullCity for request
localeStringautoLCID standard locale

​
Specialized Endpoints

​
SERP API

Collect search engine results data. Endpoints: 
POST https://api.webit.live/api/v1/realtime/serp
POST https://api.webit.live/api/v1/async/serp
POST https://api.webit.live/api/v1/batch/serp
Use Cases:
  • Monitor search rankings
  • Track competitor SEO strategies
  • Optimize SEM campaigns
  • Discover new keywords

​
Maps API

Collect geographic and location data. Endpoints: 
POST https://api.webit.live/api/v1/realtime/maps
POST https://api.webit.live/api/v1/async/maps
POST https://api.webit.live/api/v1/batch/maps
Capabilities:
  • Search for places by coordinates
  • Collect structured place information
  • Gather review data and ratings
  • Handle pagination through results

​
E-commerce API

Specialized for product and marketplace data. Endpoints: 
POST https://api.webit.live/api/v1/realtime/ecommerce
POST https://api.webit.live/api/v1/async/ecommerce
POST https://api.webit.live/api/v1/batch/ecommerce

​
Authentication

All requests require Basic Authentication: 
Authorization: Basic base64(username:password)
Content-Type: application/json
Replace username:password with your credentials and encode in base64.

​
Response Codes

CodeStatusDescription
200OKRequest successful
400Bad Request”The requested resource could not be reached”
401Unauthorized”Invalid credential string”
500Internal ErrorServer error occurred
501Proxy Error”An error was encountered by the proxy service”

​
Response Structure

​
Successful Response

{
    "status": "success",
    "html_content": "string",
    "parsing": {
        "status": "success",
        "entities": {},
        "total_entities_count": 0,
        "entities_count": {}
    }
}

​
Error Response

{
    "status": "error",
    "message": "Error description",
    "code": "ERROR_CODE"
}

​
Delivery Options

​
Real-time Delivery

Data returned immediately in API response.

​
Cloud Storage Delivery

Direct delivery to your cloud storage: 
{
    "storage_type": "s3",
    "storage_url": "s3://your-bucket/path/",
    "callback_url": "https://your-api.com/webhook"
}
Supported Platforms:
  • Amazon S3 (s3)
  • Google Cloud Storage (gs)

​
Callback Delivery

Notification sent when data is ready: 
{
    "callback_url": "https://your-api.com/webhook"
}

​
Rate Limits

Rate limits vary by subscription plan and driver type. See Functions for detailed limits.

​
Request Timeout

  • Default: 30 seconds
  • Maximum: 120 seconds (with page interactions)
  • Custom: Configure via timeout in render_options

​
Best Practices

  1. Choose the right driver for your use case
  2. Use geo-targeting for location-specific data
  3. Implement proper error handling for your requests
  4. Monitor rate limits to avoid throttling
  5. Use batch requests for multiple URLs
  6. Configure timeouts appropriately for your content