Schema library developer-ecosystem
Return a GitHub repository record from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Capture public repository metadata for ecosystem or dependency analysis.
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 GitHub repository record.
GitHub repository data for OSS research and competitive intel.
| Field | Type | What it holds |
|---|---|---|
owner | string, required | GitHub username or organization name that owns the repository. |
repo_name | string, required | Repository name (without owner prefix). |
full_name | string, required | Full repository identifier in 'owner/repo' format. |
description | string | Short description of the repository. |
homepage_url | string | Homepage URL set on the repository. |
language_primary | string | Primary programming language detected by GitHub. |
languages | array | Breakdown of programming languages used in the repository. |
topics | array | GitHub topic tags applied to the repository. |
license | string | SPDX license identifier or license name. |
is_fork | boolean | Whether this repository is a fork of another repository. |
is_archived | boolean | Whether the repository has been archived. |
is_template | boolean | Whether the repository is marked as a template. |
visibility | string | Visibility level of the repository. |
stars_count | number, required | Number of stars the repository has received. |
forks_count | number | Number of forks of this repository. |
watchers_count | number | Number of users watching the repository. |
open_issues_count | number | Number of currently open issues. |
open_prs_count | number | Number of currently open pull requests. |
contributors_count | number | Total number of contributors. |
commits_count | number | Total number of commits on the default branch. |
releases_count | number | Total number of GitHub releases published. |
latest_release_tag | string | Tag name of the latest release (e.g., 'v1.2.3'). |
latest_release_at | string | ISO 8601 datetime of the latest release. |
created_at | string | ISO 8601 datetime when the repository was created. |
pushed_at | string | ISO 8601 datetime of the most recent push. |
default_branch | string | Name of the default branch (e.g., 'main', 'master'). |
readme_url | string | URL to the raw README file. |
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 './github-repository.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./github-repository.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: package registry entry.
- The job rather than the object: the Extract API.