# Social Links Search API Documentation

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.

- **Documentation:** [https://scrappa.co/docs/contacts-api/contacts_social_links](https://scrappa.co/docs/contacts-api/contacts_social_links)
- **API group:** Contacts API
- **Endpoint:** `GET https://scrappa.co/api/contacts/social-links`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Person or company name, for example "Stripe". |
| `social_networks` | string | No | Comma separated networks: facebook, instagram, x (or twitter), linkedin, youtube, tiktok, pinterest, snapchat, github. Defaults to all. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | Returned when a required parameter is missing or a value is out of range. No credits are charged. |
| 503 | Service Unavailable | Returned when no page could be fetched or the search returned no results. Failed requests are not charged. Try again. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)