Linktree API Capability

Harvest Directory Profiles

Collect profiles across a bounded number of public directory pages using a category or subcategory filter.

Capability ID linktree.directory.profiles

Cost 1 credit per request

Maximum runtime 120 seconds

# Harvest Directory Profiles

Collect profiles across a bounded number of public directory pages using a category or subcategory filter.

- Platform: [Linktree](https://docs.upscrape.com/docs/platforms/linktree)
- Capability ID: `linktree.directory.profiles`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "category": "business",
    "max_pages": 2
  },
  "capability": "linktree.directory.profiles"
}'
```

## Input

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `category` | `string` | No | Primary directory category. Omit both filters for all profiles; mutually exclusive with subcategory. |
| `max_pages` | `integer` | No | Maximum pages to fetch (about 18 profiles each; default 10, maximum 25). The walk stops sooner at the reported end. |
| `subcategory` | `string` | No | Secondary directory filter discovered from Linktree's public taxonomy; mutually exclusive with category. |

### Example input

```json
{
  "category": "business",
  "max_pages": 2
}
```

## Response

Successful output is returned in `results[0].data`. Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This redacted fixture is an example, not a fixed response schema.

```json
{
  "pages_fetched": 2,
  "profiles": [
    {
      "avatar_url": "https://ugc.production.linktr.ee/LjwiPG26RCKWksfW1a2d_804MRaOmd7zHCIZg",
      "category_id": "business",
      "category_name": "Business",
      "profile_title": "Yeesco",
      "profile_url": "https://linktr.ee/lojasyeesco",
      "username": "lojasyeesco",
      "verified": false
    },
    {
      "avatar_url": "https://ugc.production.linktr.ee/gktK40SHi6rJZd3BQFCA_gwckDcyA5PEYqjZ5",
      "category_id": "business",
      "category_name": "Business",
      "profile_url": "https://linktr.ee/vannise2019",
      "username": "vannise2019",
      "verified": false
    },
    {
      "avatar_url": "https://ugc.production.linktr.ee/HpU1lQbTHeGWCjC7kNfm_o4KTOhJ9dKjAPCvD",
      "badges": [
        "VERIFICATION_TICK"
      ],
      "category_id": "business",
      "category_name": "Business",
      "profile_title": "Oh My Technology",
      "profile_url": "https://linktr.ee/ohmytechnology",
      "username": "ohmytechnology",
      "verified": true
    }
  ],
  "selected_category": "business"
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `pages_fetched` | `integer` | 2 |
| `profiles` | `array` | 3 items |
| `profiles` | `array` | 3 items |
| `selected_category` | `string` | business |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

category string optional

Primary directory category. Omit both filters for all profiles; mutually exclusive with subcategory.

Example business

Available values allbusinesscreativeeducationentertainmentfashion-beautyfood-beveragegovernment-politicshealth-wellnessnon-profitothertechtravel-tourism

max_pages integer optional

Maximum pages to fetch (about 18 profiles each; default 10, maximum 25). The walk stops sooner at the reported end.

Example 2

subcategory string optional

Secondary directory filter discovered from Linktree's public taxonomy; mutually exclusive with category.

Available values affiliate-marketingagency-consultingalcoholautomobilesactoractivismattractionsbars-restaurantscampus-organizationscannabischefclimateclothing-accessoriescoffee-teacomedycommunity-organizationcontests-giveawayscosplaycountries-municipalitiescraftscrowdfundingdance-theatredessertsdesignerdigital-creatordisaster-reliefdiversity-inclusione-learningedutechelectronic-press-kitemergency-servicesfan-clubfilm-tvfinancial-servicesfintechfragrancesgaming-esportsgrocerieshair-carehardwarehealthcarehome-cookinghome-improvement-maintenancehotels-lodginghr-recruitinginfluencerjewelryjudiciarylaw-enforcementlegal-serviceslibrarylife-coachinglive-eventsmakeup-skincaremarketing-advertisingmemesmilitary-veteransmobile-appmodelmuseumsmusicnail-carenot-listednutritionperformance-artpersonalpetspolicypoliticians-campaignsportfoliopublic-figurepublic-relationspublic-servicesradio-podcastsreal-estaterecreationreligionsaasschools-universitiesshoesshopping-retailsocial-mediaspiritualitysportsstartuptalent-agencytalent-managementtattoos-piercingsteachertransportationventure-capitalvisual-artsweddingswildlifewriter

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

Path	Observed type	Example
`pages_fetched`	`integer`	2
`profiles`	`array`	3 items
`profiles`	`array`	3 items
`selected_category`	`string`	business

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "category": "business", "max_pages": 2 }, "capability": "linktree.directory.profiles" }'

import json import requests payload = json.loads(r'''{ "input": { "category": "business", "max_pages": 2 }, "capability": "linktree.directory.profiles" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))

{ "pages_fetched": 2, "profiles": [ { "avatar_url": "https://ugc.production.linktr.ee/LjwiPG26RCKWksfW1a2d_804MRaOmd7zHCIZg", "category_id": "business", "category_name": "Business", "profile_title": "Yeesco", "profile_url": "https://linktr.ee/lojasyeesco", "username": "lojasyeesco", "verified": false }, { "avatar_url": "https://ugc.production.linktr.ee/gktK40SHi6rJZd3BQFCA_gwckDcyA5PEYqjZ5", "category_id": "business", "category_name": "Business", "profile_url": "https://linktr.ee/vannise2019", "username": "vannise2019", "verified": false }, { "avatar_url": "https://ugc.production.linktr.ee/HpU1lQbTHeGWCjC7kNfm_o4KTOhJ9dKjAPCvD", "badges": [ "VERIFICATION_TICK" ], "category_id": "business", "category_name": "Business", "profile_title": "Oh My Technology", "profile_url": "https://linktr.ee/ohmytechnology", "username": "ohmytechnology", "verified": true } ], "selected_category": "business" }