Overview
The EasyParser Real-Time API is engineered for immediate data extraction, providing instant responses to your on-demand requests. Unlike the Bulk Integration, which is optimized for high-volume, asynchronous processing, the Real-Time API operates synchronously, delivering parsed, structured data directly in the response body. This makes it the ideal solution for applications where low latency and immediate results are critical.
All data, regardless of the operation performed, is returned in a consistent, standardized JSON format, ensuring seamless integration into your live applications and workflows.
🚀 Use Cases and Advantages
The Real-Time API is best suited for scenarios demanding instant data access and minimal delay.
Live Applications and Dashboards
Displaying up-to-the-minute product information or pricing on a user-facing platform.
Ensures users always see the most current data.
Trigger-Based Workflows
Automatically fetching product details when a specific event occurs (e.g., a user clicks a link).
Enables immediate, context-aware actions within your system.
Time-Sensitive Lookups
One-off checks for price verification, stock availability, or quick data validation.
Provides instant confirmation or data points without delay.
Testing and Development
Rapidly prototyping and testing new features or data models.
Facilitates fast iteration and debugging with immediate feedback.
🔄 Synchronous Flow
The Real-Time API follows a simple, synchronous request-response model:
Request: Your application sends a single HTTP request to the EasyParser Real-Time API endpoint, including all necessary parameters and your
api_key.Processing: EasyParser processes the request instantly, navigates the target e-commerce page (Amazon), extracts the required data, and structures it into JSON.
Response: The API returns the complete, structured JSON data directly in the response body of the same request.
There is no need for job IDs, polling, or webhooks. The entire process is completed in a single, low-latency transaction.
🔑 Authentication and Request Structure
Authentication is handled via a mandatory api_key parameter included in the request URL. This key identifies your account and manages your usage limits.
Example Request (Product Detail Operation)
The following cURL example demonstrates a request to retrieve detailed product information (the DETAIL operation) for a specific Amazon ASIN:
curl --location 'https://realtime.easyparser.com/v1/request?api_key=YOUR_API_KEY&platform=AMZ&operation=DETAIL&output=json&domain=.com&asin=B0D4215HCX&include_html=false'For a complete list of parameters for the DETAIL, SEARCH, OFFER,PRODUCT LOOKUP and other operations, explore each operation’s Request documentation using the cards below.
⏱ Technical Limitations and Performance
To ensure service stability and fair usage across all users, the Real-Time API has the following technical constraints:
Maximum Response Time (Timeout)
15 seconds
If the data extraction process exceeds 15 seconds, the request will time out and return an error. This ensures your applications do not hang on slow responses.
Rate Limiting
Varies by Subscription Plan
The number of requests you can send per minute is determined by your active EasyParser subscription plan. Exceeding this limit will result in a rate limit error.
🧪 Testing and Experimentation (Playground)
The Playground demonstrates the standardized JSON response structure you will receive from the Real-Time API. This web-based interface allows you to construct requests, view the structured JSON response, and see the exact cURL command generated for your request. It is an excellent tool for understanding the API's parameters and expected output before writing any code.
To begin your testing, you can sign up for a free demo package, which renews monthly and provides you with a valid api_key and a set of free credits.
All Real-Time API responses follow a standardized JSON format, though the structure and available fields may differ slightly between operations.
A typical response includes four main top-level objects:
request_info
General status of the API call, including success status and status_code.
request_parameters
An echo of the parameters sent in the request (e.g., output, language).
request_metadata
Processing details for the request, such as created_at, processed_at, and the crucial total_time_taken (confirming the low-latency nature).
result
Contains the extracted data, nested under the operation type (e.g., detail, search). This is where the specific data payload resides.
For detailed JSON schemas and response examples for each operation, explore the response documentation using the cards below.
Last updated