Getting Started

Parsium extracts structured data from any webpage. You can build custom parsers in the dashboard or use prebuilt endpoints for popular platforms like Instagram, YouTube, TikTok, LinkedIn, and more.

Get your API key

1. Sign up at parseium.com
2. Go to API Keys in the dashboard
3. Create a new key

Authentication

Pass your API key via header or query parameter:

# Header (recommended)
curl -H "X-API-Key: your_key" https://api.parseium.com/v1/credits

# Query parameter
curl "https://api.parseium.com/v1/credits?api_key=your_key"

Quick example: scrape a page

If you’ve created a parser in the dashboard, you can scrape any URL:

const res = await fetch(
  "https://api.parseium.com/v1/scrape/your_parser_id?url=https://example.com",
  { headers: { "X-API-Key": "your_key" } }
);
const data = await res.json();

import requests

res = requests.get(
    "https://api.parseium.com/v1/scrape/your_parser_id",
    params={"url": "https://example.com"},
    headers={"X-API-Key": "your_key"},
)
data = res.json()

Quick example: prebuilt API

No parser needed — use prebuilt endpoints directly:

const res = await fetch(
  "https://api.parseium.com/v1/instagram-profile?username=natgeo",
  { headers: { "X-API-Key": "your_key" } }
);
const profile = await res.json();
console.log(profile.metrics.followers);

import requests

res = requests.get(
    "https://api.parseium.com/v1/instagram-profile",
    params={"username": "natgeo"},
    headers={"X-API-Key": "your_key"},
)
profile = res.json()
print(profile["metrics"]["followers"])

Check your credits

curl -H "X-API-Key: your_key" https://api.parseium.com/v1/credits

{
  "creditBalance": 4850,
  "concurrency": 5
}

Error handling

All errors return JSON with an error field. Key status codes:

Code	Meaning
401	Invalid or missing API key
402	Insufficient credits
404	Parser or resource not found
413	HTML exceeds 16 MB
429	Rate limit exceeded (check Retry-After header)
502	Failed to fetch target URL (scrape only)

Response headers

Scrape and prebuilt endpoints return credit info in headers:

• X-Credits-Used — credits consumed by this request
• X-Credits-Remaining — remaining balance

Next steps

• Browse the API Reference for full endpoint details
• Explore prebuilt APIs for Instagram, YouTube, TikTok, LinkedIn, Reddit, and more
• Fetch full response schemas programmatically via GET /v1/apis/{endpoint-name}