Schema library developer-ecosystem

Return a package-registry record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Normalize public package metadata, versions, links, and stated requirements.

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 package-registry record.

Package from npm, PyPI, crates.io, etc.

Field	Type	What it holds
`registry`	string, required	The package registry this entry comes from.
`package_name`	string, required	Name of the package as listed in the registry.
`package_version`	string, required	Version of the package this record describes.
`latest_version`	string	The latest stable version available in the registry.
`description`	string	Short description of the package.
`homepage_url`	string	Homepage URL for the package.
`repository_url`	string	Source repository URL (e.g., GitHub link).
`license`	string	SPDX license identifier or license name.
`keywords`	array	Keywords or tags associated with the package.
`author_name`	string	Name of the primary author.
`author_email`	string	Email of the primary author.
`maintainers`	array	List of maintainer usernames or names.
`dependencies`	array	List of runtime dependencies.
`dev_dependencies`	array	List of development dependencies.
`weekly_downloads`	number	Number of downloads in the past 7 days.
`total_downloads`	number	Total all-time download count.
`dependent_packages_count`	number	Number of packages that depend on this package.
`github_stars`	number	GitHub star count for the linked repository.
`open_issues_count`	number	Number of open issues on the repository.
`first_published_at`	string	ISO 8601 datetime when the package was first published.
`last_published_at`	string	ISO 8601 datetime of the most recent release.
`deprecated`	boolean	Whether the package has been marked as deprecated.
`deprecation_message`	string	Message explaining why or what to migrate to.
`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.

package.tsTypeScript

import schema from './package-registry-entry.json'

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

tabstack extract json 'https://example.com/pricing' \
  --schema @./package-registry-entry.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: github repository.
The job rather than the object: the Extract API.