Skip to content
Scrappa Get API key
Contacts API 1 credit/request

Social Links Search API Documentation

GET https://scrappa.co/api/contacts/social-links

Searches the web once for a name and returns social profile links grouped by network: Facebook, Instagram, X, LinkedIn, YouTube, TikTok, Pinterest, Snapchat and GitHub. Links are cleaned to the profile page: tracking parameters, country hosts, posts, videos and share links are removed. Each link has the handle, the result title, the snippet and its search position. Only networks with hits appear. Cost: 1 credit per request. A search that returns no page is free. One request reads one search page, so a rare name may find few networks.

Social Links Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/contacts/social-links
Auth header
x-api-key
Cost
1 credit/request
query = Stripe
Response preview
200 OK
{
    "data": {
        "github": [
            {
                "url": "https://github.com/stripe",
                "title": "Stripe",
                "handle": "stripe",
                "snippet": "Stripe has 400 repositories available.",
                "position": 4
            }
        ],
        "linkedin": [
            {
                "url": "https://www.linkedin.com/company/stripe",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

1 optional filter available.

query string Required

Person or company name, for example "Stripe".

Example value Stripe
social_networks string Optional

Comma separated networks: facebook, instagram, x (or twitter), linkedin, youtube, tiktok, pinterest, snapchat, github. Defaults to all.

Example value linkedin,x,github

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta query success networks
JSON Response
200 OK
{
    "data": {
        "github": [
            {
                "url": "https://github.com/stripe",
                "title": "Stripe",
                "handle": "stripe",
                "snippet": "Stripe has 400 repositories available.",
                "position": 4
            }
        ],
        "linkedin": [
            {
                "url": "https://www.linkedin.com/company/stripe",
                "title": "Stripe | LinkedIn",
                "handle": "stripe",
                "snippet": "Stripe | 1,200,000 followers on LinkedIn.",
                "position": 1
            }
        ]
    },
    "meta": {
        "credits": 1,
        "duration_ms": 1800,
        "upstream_calls": 1
    },
    "query": "Stripe",
    "success": true,
    "networks": [
        "linkedin",
        "x",
        "github"
    ]
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

Validation Error

Returned when a required parameter is missing or a value is out of range. No credits are charged.

Service Unavailable

Returned when no page could be fetched or the search returned no results. Failed requests are not charged. Try again.

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.