Schema library gov-public-records

Return a government-contract award from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Capture public agency, supplier, amount, dates, description, and source identifiers.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

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 government-contract award.

Federal or state government contract, grant, or other award from USASpending.gov or equivalent.

Field	Type	What it holds
`award_id`	string, required	Unique award identifier.
`piid`	string	Procurement Instrument Identifier (PIID) for contracts.
`award_type`	string, required	Type of award.
`agency_name`	string, required	Name of the awarding government agency.
`agency_code`	string	Agency code.
`sub_agency_name`	string	Name of the sub-agency or office.
`award_date`	string, required	Date of the award.
`start_date`	string	Period of performance start date.
`end_date`	string	Period of performance end date.
`potential_total_value_usd`	number	Total potential value of the contract in USD.
`obligated_amount_usd`	number, required	Amount obligated in USD.
`vendor_name`	string, required	Name of the vendor or awardee.
`vendor_domain`	string	Website domain of the vendor.
`vendor_address`	string	Street address of the vendor.
`vendor_city`	string	City of the vendor.
`vendor_state`	string	State of the vendor.
`vendor_country`	string	Country of the vendor.
`vendor_size`	string	Business size of the vendor.
`naics_code`	string	NAICS code for the award.
`naics_description`	string	NAICS code description.
`psc_code`	string	Product and Service Code (PSC).
`award_description`	string	Description of the award.
`set_aside_type`	string	Set-aside type for socioeconomic programs.
`competitive_procedures`	string	Competitive procedures used.
`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.

Example data, not a live response.

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.

government.tsTypeScript

import schema from './government-contract-award.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./government-contract-award.json

Adaptation

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 schemas

Other schemas in this category.

Same category: building permit.
Same category: business registration.
Same category: court filing / case.
The job rather than the object: the Extract API.