Schema library finance
Return an alternative-asset listing from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Structure public listing details for an alternative asset. Check the official source before acting on it.
TEXT
MARKDOWN
LINKS
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: {
type: 'object',
properties: {
plan: { type: 'string' },
price: { type: 'number' },
},
},
})res = client.extract.json(
url='https://example.com/pricing',
json_schema={
'type': 'object',
'properties': {
'plan': {'type': 'string'},
'price': {'type': 'number'},
},
},
)tabstack extract json https://example.com/pricing \
--schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'What it captures
Fields in this alternative-asset listing.
Listing for an alternative asset such as art, wine, watches, sports cards, sneakers, or other collectibles.
| Field | Type | What it holds |
|---|---|---|
item_name | string, required | Name or title of the item. |
item_type | string, required | Category of the alternative asset. |
artist_or_maker | string | Artist, brand, or maker of the item. |
title_or_model | string | Title of artwork or model name/number. |
year | number | Year of creation or manufacture. |
condition_grade | string | Condition or grade of the item. |
authentication_status | boolean | Whether the item has been authenticated. |
authentication_provider | string | Name of the authentication or grading service. |
platform | string, required | Name of the marketplace or auction platform. |
listing_type | string, required | Type of sale mechanism. |
estimate_low_usd | number | Low end of auction house price estimate in USD. |
estimate_high_usd | number | High end of auction house price estimate in USD. |
starting_bid_usd | number | Starting bid for auction in USD. |
current_bid_usd | number | Current highest bid in USD (for live auctions). |
buy_now_price_usd | number | Fixed buy-now price in USD. |
currency | string | Currency code for the listed prices. |
auction_date | string | Date of the auction. |
sale_result_usd | number | Final sale price in USD (post-auction). |
images | array | URLs of item images. |
description | string | Full description of the item. |
page_title | string | Title of the source page. Tabstack auto-fills this from page metadata when left empty. |
favicon | string | Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty. |
Example
Inspect and validate the response shape.
The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.
What it checks
Pass or fail, and the first reason why.
Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
Usage
Send the schema with your source URL.
The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
import schema from './alternative-asset-listing.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./alternative-asset-listing.jsonAdaptation
Make the schema match your application.
The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.
Remove what you do not need
A shorter schema is a smaller response and fewer fields to handle.
Describe the ambiguous ones
A description tells Extract what to look for when a label could mean two things.
Validate before you store
Check the returned object against the schema rather than trusting it.
Related
Related schemas
Other schemas in this category.
- Same category: angel & seed deal.
- Same category: crypto asset.
- Same category: public company filing.
- The job rather than the object: the Extract API.