JSON

extract.json() -> ExtractJsonResponse

POST/extract/json

Fetches a URL and extracts structured data according to a provided JSON schema

ParametersExpand Collapse

json_schema: object

JSON schema definition that describes the structure of data to extract.

url: str

URL to fetch and extract data from

formaturi

effort: Optional[Literal["min", "standard", "max"]]

Fetch effort level controlling speed vs. capability tradeoff. "min": fastest, no fallback (1-5s). "standard": balanced with enhanced reliability (default, 3-15s). "max": full browser rendering for JS-heavy sites (15-60s).

Accepts one of the following:

"min"

"standard"

"max"

geo_target: Optional[GeoTarget]

Optional geotargeting parameters for proxy requests

country: Optional[str]

Country code using ISO 3166-1 alpha-2 standard (2 letters, e.g., "US", "GB", "JP"). See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

nocache: Optional[bool]

Bypass cache and force fresh data retrieval

ReturnsExpand Collapse

Dict[str, object]

JSON

import os
from tabstack import Tabstack

client = Tabstack(
    api_key=os.environ.get("TABSTACK_API_KEY"),  # This is the default and can be omitted
)
response = client.extract.json(
    json_schema={
        "properties": {
            "stories": {
                "items": {
                    "properties": {
                        "author": {
                            "description": "Author username",
                            "type": "string",
                        },
                        "points": {
                            "description": "Story points",
                            "type": "number",
                        },
                        "title": {
                            "description": "Story title",
                            "type": "string",
                        },
                    },
                    "type": "object",
                },
                "type": "array",
            }
        },
        "type": "object",
    },
    url="https://news.ycombinator.com",
)
print(response)

{
  "error": "invalid JSON request body"
}

{
  "error": "failed to fetch URL"
}

Returns Examples

{
  "error": "invalid JSON request body"
}

{
  "error": "failed to fetch URL"
}