Linktree API: Каталог — Пользователи по категории

Что делает этот эндпоинт

Что можно сделать с этим API-методом

Сначала оцените результат и сценарии применения, затем переходите к параметрам и рабочему примеру запроса.

Результат запроса

Ответ содержит публичные данные «Каталог» и служебный контекст, необходимый для последующих API-запросов.

Когда использовать

Метод подходит, когда известен входной идентификатор или параметр и требуется предсказуемый API-ответ по одному сценарию.

Типовые сценарии использования

Точечное получение данных

Запрашивайте только нужный объект без загрузки более тяжёлых коллекций.

Обогащение продукта

Добавляйте результат Linktree API в карточки, процессы и внутренние инструменты.

Оркестрация запросов

Используйте ответ как вход для соседних методов и многошаговых сценариев.

Доступные версии

Версия ответа

Обе версии решают одну и ту же задачу и принимают одинаковые параметры. Переключатель нужен, чтобы сравнить структуру ответа и выбрать версию, которую ожидает ваш клиент.

Версия ответа V2

Переключайте версии на этой странице, чтобы сравнивать структуру ответа без смены URL инструкции.

Что остается одинаковым

Аутентификация, обязательные параметры и форма запроса одинаковы для V1 и V2. Версия задаётся в пути запроса и определяет структуру ответа.

Что меняется между версиями

Главное отличие — envelope ответа. Для новых интеграций лучше использовать V2, а V1 оставлять только для совместимости с уже существующей клиентской интеграцией.

Как использовать

Как вызвать метод

Для обеих версий используется один заголовок API-ключа и одинаковые параметры строки запроса. Ниже сначала показаны общие параметры, затем путь и примеры кода для выбранной версии.

Входные параметры

Общие параметры

Параметр	Обязателен	Тип	Пример	Описание
`category`	Да	`all \| business \| creative \| education \| entertainment \| fashion-beauty \| food-beverage \| government-politics \| health-wellness \| non-profit \| other \| tech \| travel-tourism`	`all`	Linktree directory category slug. Example: all.
`page`	Нет	`int`	`1`	Requested results page number. Example: 1.

Путь запроса для выбранной версии

V2

Версию имеет смысл выбирать, когда вы копируете точный путь эндпоинта, пример URL и фрагмент кода. Список параметров выше при этом остается тем же самым.

GET /api/v2/linktr.ee/directory/users-by-category

Нормализованный формат

Предпросмотр запроса

Базовый URL https://www.scrapestorm.net

Эндпоинт /api/v2/linktr.ee/directory/users-by-category

Обязательные параметры

Примеры кода

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/linktr.ee/directory/users-by-category" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'category=all' \
  # Optional parameters:
  # --data-urlencode 'page=1'

from urllib.parse import urljoin

import requests

BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/linktr.ee/directory/users-by-category"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}

params = {
    "category": "all",
}

# Optional parameters
# params["page"] = "1"

with requests.Session() as session:
    response = session.request(
        method="GET",
        url=urljoin(BASE_URL, ENDPOINT),
        headers=HEADERS,
        params=params,
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()

print(payload)

const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v2/linktr.ee/directory/users-by-category";

const params = new URLSearchParams({
  category: "all",
});

// Optional parameters
// params.set("page", "1");

const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const payload = await response.json();
console.log(payload);

import axios from "axios";

const client = axios.create({
  baseURL: "https://www.scrapestorm.net",
  timeout: 30000,
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

const params = {
  category: "all",
};

// Optional parameters
// params.page = "1";

const { data: payload } = await client.request({
  method: "GET",
  url: endpoint,
  params,
});

console.log(payload);

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client([
    'base_uri' => "https://www.scrapestorm.net",
    'timeout' => 30.0,
    'headers' => [
        'Accept' => 'application/json',
        'X-API-Key' => "00000000-0000-4000-8000-000000000000",
    ],
]);

$query = [
    "category" => "all",
];

// Optional parameters
// $query["page"] = "1";

try {
    $response = $client->request("GET", "/api/v2/linktr.ee/directory/users-by-category", [
        'query' => $query,
    ]);

    $payload = json_decode(
        (string) $response->getBody(),
        true,
        512,
        JSON_THROW_ON_ERROR
    );

    var_dump($payload);
} catch (GuzzleException $e) {
    throw $e;
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
    "time"
)

func main() {
    baseURL := "https://www.scrapestorm.net"
    endpoint := "/api/v2/linktr.ee/directory/users-by-category"

    params := url.Values{}
    params.Set("category", "all")

    // Optional parameters
    // params.Set("page", "1")

    req, err := http.NewRequest(
        "GET",
        fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
        nil,
    )
    if err != nil {
        panic(err)
    }

    req.Header.Set("Accept", "application/json")
    req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")

    client := &http.Client{Timeout: 30 * time.Second}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload any
    if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", payload)
}

Путь запроса для выбранной версии

V1

Версию имеет смысл выбирать, когда вы копируете точный путь эндпоинта, пример URL и фрагмент кода. Список параметров выше при этом остается тем же самым.

GET /api/v1/linktr.ee/directory/users-by-category

Исходный формат платформы

Предпросмотр запроса

Базовый URL https://www.scrapestorm.net

Эндпоинт /api/v1/linktr.ee/directory/users-by-category

Обязательные параметры

Примеры кода

curl --request GET \
  --url "https://www.scrapestorm.net/api/v1/linktr.ee/directory/users-by-category" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'category=all' \
  # Optional parameters:
  # --data-urlencode 'page=1'

from urllib.parse import urljoin

import requests

BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/linktr.ee/directory/users-by-category"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}

params = {
    "category": "all",
}

# Optional parameters
# params["page"] = "1"

with requests.Session() as session:
    response = session.request(
        method="GET",
        url=urljoin(BASE_URL, ENDPOINT),
        headers=HEADERS,
        params=params,
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()

print(payload)

const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v1/linktr.ee/directory/users-by-category";

const params = new URLSearchParams({
  category: "all",
});

// Optional parameters
// params.set("page", "1");

const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const payload = await response.json();
console.log(payload);

import axios from "axios";

const client = axios.create({
  baseURL: "https://www.scrapestorm.net",
  timeout: 30000,
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

const params = {
  category: "all",
};

// Optional parameters
// params.page = "1";

const { data: payload } = await client.request({
  method: "GET",
  url: endpoint,
  params,
});

console.log(payload);

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client([
    'base_uri' => "https://www.scrapestorm.net",
    'timeout' => 30.0,
    'headers' => [
        'Accept' => 'application/json',
        'X-API-Key' => "00000000-0000-4000-8000-000000000000",
    ],
]);

$query = [
    "category" => "all",
];

// Optional parameters
// $query["page"] = "1";

try {
    $response = $client->request("GET", "/api/v1/linktr.ee/directory/users-by-category", [
        'query' => $query,
    ]);

    $payload = json_decode(
        (string) $response->getBody(),
        true,
        512,
        JSON_THROW_ON_ERROR
    );

    var_dump($payload);
} catch (GuzzleException $e) {
    throw $e;
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
    "time"
)

func main() {
    baseURL := "https://www.scrapestorm.net"
    endpoint := "/api/v1/linktr.ee/directory/users-by-category"

    params := url.Values{}
    params.Set("category", "all")

    // Optional parameters
    // params.Set("page", "1")

    req, err := http.NewRequest(
        "GET",
        fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
        nil,
    )
    if err != nil {
        panic(err)
    }

    req.Header.Set("Accept", "application/json")
    req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")

    client := &http.Client{Timeout: 30 * time.Second}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload any
    if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", payload)
}

Пример ответа

Пример ответа по версиям

Пример сокращён до ключевых полей и первых элементов коллекций, чтобы структуру ответа можно было быстро оценить. Переключатель версии меняет формат JSON.

Пример ответа

V2 — JSON

Проверенный пример

Компактный JSON-пример сформирован из последней успешной проверки версии V2.

{
  "success": true,
  "status": "ok",
  "pagination": {
    "page": 1,
    "has_more": true
  },
  "search_context": {
    "category": "all",
    "page": 1
  },
  "data": {
    "directory_context": {
      "selected_category": {
        "category_id": "all",
        "label": "All Categories"
      },
      "selected_subcategory": null,
      "title": "Explore the Linktree community",
      "description": "Discover everything our most popular creators are sharing all over the internet, in one simple place."
    },
    "categories": {
      "count": 13,
      "items": [
        {
          "category_id": "all",
          "label": "All Categories"
        },
        {
          "category_id": "business",
          "label": "🏢 Business"
        },
        {
          "_more_items": 11
        }
      ]
    },
    "profiles": {
      "count": 18,
      "items": [
        {
          "username": "marjem",
          "display_name": "Marjem Kat",
          "url": "https://linktr.ee/marjem",
          "avatar_url": "https://example.com/image.jpg",
          "category": {
            "category_id": "other",
            "label": "Other"
          },
          "badges": [],
          "is_verified": false
        },
        {
          "username": "frontlinesmedia",
          "display_name": "Frontlinesmedia",
          "url": "https://linktr.ee/frontlinesmedia",
          "avatar_url": "https://example.com/image.jpg",
          "category": {
            "category_id": "entertainment",
            "label": "Entertainment"
          },
          "badges": [],
          "is_verified": false
        },
        {
          "_more_items": 16
        }
      ]
    },
    "total_pages": null
  }
}

Пример ответа

V1 — JSON

Проверенный пример

Компактный JSON-пример сформирован из последней успешной проверки версии V1.

{
  "success": true,
  "status": "ok",
  "search_context": {
    "page": 1,
    "category": "all"
  },
  "data": {
    "pageProps": {
      "profiles": [
        {
          "profileTitle": "Marjem Kat",
          "username": "marjem",
          "category": {
            "categoryId": "other",
            "label": "Other"
          },
          "customAvatarUrl": "https://example.com/image.jpg",
          "profileBadges": [],
          "verificationTick": false
        },
        {
          "profileTitle": "Frontlinesmedia",
          "username": "frontlinesmedia",
          "category": {
            "categoryId": "entertainment",
            "label": "Entertainment"
          },
          "customAvatarUrl": "https://example.com/image.jpg",
          "profileBadges": [],
          "verificationTick": false
        },
        {
          "_more_items": 16
        }
      ],
      "categories": [
        {
          "categoryId": "all",
          "label": "All Categories"
        },
        {
          "categoryId": "business",
          "label": "🏢 Business"
        },
        {
          "_more_items": 11
        }
      ],
      "selectedCategory": {
        "categoryId": "all",
        "label": "All Categories"
      },
      "selectedSubCategory": null,
      "currentPage": 1,
      "hasMore": true,
      "pageTitle": "Explore the Linktree community",
      "pageDescription": "Discover everything our most popular creators are sharing all over the internet, in one simple place."
    }
  }
}

Что делать дальше

Продолжить оценку API-метода

Используйте инструкцию как первую точку принятия решения, а затем переходите к покрытию, стоимости и общим правилам интеграции перед запуском API-метода.

Открыть страницу Linktree API

Сравните соседние сущности, группы API-методов и связанные инструкции перед внедрением.

Открыть страницу платформы

Сравнить стоимость API-методов

Посмотрите, где этот API-метод находится в публичной таблице цен, прежде чем масштабировать использование.

Открыть тарифы

Проверить правила интеграции

Откройте стартовую документацию, чтобы быстро проверить аутентификацию, версионирование, повторы запросов и различия между тестовым и рабочим API.

Открыть документацию

FAQ

Вопросы, которые команды задают до внедрения

Эти ответы помогают понять, подходит ли API-метод под ваш сценарий, выбор версии и запуск.

Какие данные возвращает этот метод Linktree API?

Метод выполняет операцию «Пользователи по категории» для сущности «Каталог». Точный набор полей показан в компактном примере ответа ниже.

Какую версию ответа выбрать: V1 или V2?

Для новой интеграции выбирайте V2 с нормализованной структурой. V1 нужен только для совместимости с клиентами, которые уже используют исходный формат платформы.

Что нужно для первого запроса?

Создайте API-ключ, передайте его в заголовке и заполните обязательные параметры из таблицы. Готовые примеры кода уже содержат правильный путь и структуру запроса.