Extract JSON

Pull structured data off any public web page. You supply a JSON Schema describing the object you want and the fields are located on the page and returned under result, already typed.

post/global/extract/json/v1

Request

Base URL: https://api.croma.run
URL: https://api.croma.run/global/extract/json/v1
Auth: HTTP bearer

Headers

Idempotency-Keystring

Example:0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Request body

urlstring uri required

Public http or https URL of the page to read. Loopback and private addresses are not accepted.

json_schemaobject required

JSON Schema for the object to return. Field names and nesting are yours; describe each field so it can be located on the page.

effort'min' | 'standard' | 'max'

Effort to spend on the page: min is fastest and may serve a recent copy, standard is the balanced default, max always reads the page live and handles pages that render themselves in the browser.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.