SharedCount API

Guides, examples, and live requests for API v1.1.

Current versionv1.1

Bulk API overview

The Bulk API allows you to process multiple URLs efficiently in a single request. This endpoint is available to users on paid plans and provides a queue-based system for handling large batches of URLs.


Interactive walkthrough

Try the complete bulk flow

Queue a small sample, capture its bulk_id, then fetch the results without leaving this page.

Live API
1

Submit a sample bulk

Enter regular URLs. This tool URL-encodes each line for the API.

Ready to submit
The POST response will appear here.
2

Fetch the bulk results

After a successful POST, the returned bulk ID appears here automatically.

Ready when you have a bulk ID
Waiting for a bulk ID
The GET response will appear here.

How it works

  1. Submit the URLs. Send one URL per line to the POST /v1.1/bulk endpoint.
  2. Save the job ID. The response includes a bulk_id and the number of accepted URLs.
  3. Poll for results. Pass the bulk_id to GET /v1.1/bulk until _meta.completed is true.

Response examples

When you submit URLs, you'll receive a response like this:

{
  "count": 921,
  "bulk_id": "4a7d9ca68177713593c713cc584a7edf9ee9017c"
}

When retrieving results, you'll get data in this format:

{
  "data": {
    "https://example.com/": {
      "Facebook": {
        "total_count": 1234,
        "comment_count": 56,
        "reaction_count": 789,
        "share_count": 1234
      },
      "Pinterest": 567
    }
  },
  "_meta": {
    "urls_completed": 100,
    "bulk_id": "abc123...",
    "completed": true,
    "urls_queued": 100
  }
}

Batch size limits

The maximum number of URLs per batch depends on your plan:

PlanURL Limit
Personal500 URLs
Professional1,000 URLs
Enterprise10,000 URLs

Note: Each URL in a batch counts against your daily API quota. Requests exceeding your quota will be rejected.


Best practices

Follow these guidelines for optimal bulk API usage:

PracticeDetails
Polling FrequencyPoll every 30-60 seconds to avoid overwhelming the API
Force ParameterUse &force=1 for long-running jobs to get partial results
Progress MonitoringCheck the _meta.completed field to know when all URLs are processed
DebuggingKeep track of your bulk_id for troubleshooting and support
Real-time ProgressMonitor urls_completed vs urls_queued fields to track processing progress in real-time

For detailed implementation examples and complete API reference, see the POST/v1.1/bulk and GET/v1.1/bulk endpoint documentation.

Get your API key