{
"data": [
{
"value": "4010.00",
"raw_text": "4,010.00"
}
],
"validation": {
"status": "ok",
"reason": "no_reference",
"value": 4010,
"model_value": 4010,
"raw_text": "4,010.00",
"reference": null,
"change_pct": null,
"suspect_pct": 10,
"reject_pct": 30,
"on_page": true,
"votes": [],
"mode": "shadow",
"reference_source": null
}
}
curl --location --request GET 'https://zylalabs.com/api/14427/screenshot+to+data+api/36435/extract+from+page?url=https://www.investing.com/commodities/gold&raw_text=true&value_field=value&parse_description=Current gold futures price as a plain number, in a field called value&last_value=4012.5&expiration_seconds=600&max_chars=6000&raw_text=true&value_field=value&last_value=4012.5&max_chars=6000' --header 'Authorization: Bearer YOUR_API_KEY'
{
"data": [
{
"value": 4066.5
}
],
"validation": {
"status": "ok",
"reason": "no_reference",
"value": 4066.5,
"model_value": 4066.5,
"raw_text": null,
"suspect_pct": 10,
"reject_pct": 30,
"on_page": null,
"votes": [],
"mode": "shadow"
}
}
curl --location --request GET 'https://zylalabs.com/api/14427/screenshot+to+data+api/36436/extract+from+screenshot?url=https://www.investing.com/commodities/gold&llm_instructions=Current gold price in USD as a number, in a field called value&expiration_seconds=600&value_field=value&last_value=4012.5' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Screenshot To Data API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime.
(Save 2 months with annual billing 🎉)
A JSON object with two parts: data, the fields you asked for in your instruction, and validation, a check of the main numeric value (status ok, suspect, rejected or unchecked, the reason, the raw text as written on the page and the thresholds used).
In plain language, through parse_description (text endpoint) or llm_instructions (screenshot endpoint). Name the fields you want back, for example "product name, price in USD as a number and availability, in fields called name, price and in_stock".
Use Extract From Page by default: it is faster and works on the page text. Switch to Extract From Screenshot when the data only shows once the page is rendered, such as charts, widgets, canvas tables or JavaScript-heavy apps.
Whether the number is actually written on the page (on_page), whether it looks like a decimal shift (x10, x100), and how far it moved from the last accepted value for the same URL and instruction. You always receive the answer; the status tells you how much to trust it.
Yes. Send last_value with the last number you stored for that URL and instruction and the validation compares against it instead of the service history. Use value_field when your answer has several numbers.
No. The page and the answer are reused for the same URL and instruction while they are younger than expiration_seconds (default 600 seconds). Send 0 to force a fresh fetch.
Extract From Page reads the server-rendered text. For content that only appears after the page runs its scripts, use Extract From Screenshot, which renders the page in a browser before reading it.
The response comes with error true and a message describing the problem (blocked page, timeout, upstream error). The call is not counted as successful.
Both endpoints return structured JSON data. The Extract From Page endpoint provides fields based on the page's HTML text, while Extract From Screenshot returns data from rendered content, such as charts or widgets. Each response includes a validation block to assess the accuracy of numeric values.
The key fields in the response data include "value," which contains the extracted numeric data, and "raw_text," which shows the original text from the page. The validation block includes fields like "status," "reason," and "on_page" to indicate the reliability of the extracted data.
The response data is organized into two main sections: "data" and "validation." The "data" section contains the extracted fields, while the "validation" section provides insights into the accuracy and reliability of the extracted numeric values, including status and reasons for any discrepancies.
Extract From Page is suitable for text-based data like prices and specifications, while Extract From Screenshot is designed for visual data that requires rendering, such as charts and dynamic content. Both endpoints can extract various types of information based on user instructions.
Users can customize requests by specifying the "parse_description" for Extract From Page or "llm_instructions" for Extract From Screenshot. They can define the fields they want to extract and provide a "last_value" for validation comparisons, enhancing the accuracy of the results.
The data is sourced from publicly accessible web pages. The API fetches the content directly from the specified URL, ensuring that the extracted information reflects the most current data available on the page.
Data accuracy is maintained through a validation layer that checks extracted numeric values against the page text, historical values, and potential decimal shifts. This process helps ensure that the returned data is reliable and trustworthy.
Typical use cases include price monitoring for commodities, competitor analysis, extracting product specifications, and feeding AI systems with verified live data. The API is particularly useful for scenarios where data extraction needs to adapt to changes in web page design.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund