Schema library social-content

Return a public social-profile record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Structure public profile fields allowed by the source.

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 public social-profile record.

Platform social profile (LinkedIn company, Twitter/X, etc.)

Field	Type	What it holds
`platform`	string, required	The social platform this profile belongs to.
`profile_type`	string, required	Whether this profile belongs to a person, company, or organization.
`username_or_handle`	string, required	The username or @handle for this profile.
`display_name`	string, required	The public display name of the profile.
`bio`	string	Short biography or description text on the profile.
`follower_count`	number	Number of followers.
`following_count`	number	Number of accounts the profile is following.
`post_count`	number	Total number of posts or tweets published.
`verified`	boolean	Whether the profile has a verified badge.
`website_url`	string	External website URL listed on the profile.
`location`	string	Self-reported location of the profile.
`founded_year`	number	Year the company was founded. Applicable to company profiles.
`employee_count_range`	string	Employee count range for company profiles (e.g., '11-50').
`industry`	string	Industry classification for company profiles.
`profile_url`	string, required	Canonical URL of the profile page.
`avatar_url`	string	URL to the profile avatar / profile picture.
`banner_url`	string	URL to the profile banner / header image.
`pinned_post_url`	string	URL of the pinned post on the profile.
`engagement_rate_pct`	number	Engagement rate as a percentage.
`snapshot_at`	string	Timestamp when the profile data was snapshotted.
`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.

social.tsTypeScript

import schema from './social-profile.json'

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

tabstack extract json 'https://example.com/pricing' \
  --schema @./social-profile.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: news article.
Same category: software review.
The job rather than the object: the Extract API.