Kwai Profile
Kwaiプロフィールは、ユーザー名、表示名、プロフィール文、プロフィール画像、ウェブサイト、アカウントフラグ、表示中のフォロワー数・フォロー数・投稿数を含む公開アカウントページです。これらの識別情報と特定時点の指標は、プロフィール情報の補完、アカウント比較、繰り返し取得したスナップショットの監視に活用できます。
Kwai Profile API の主な機能
- 2種類の識別子に対応有効なユーザー名、kwai.com または kwai-video.com 上のプロフィールURL、または同じタスク内でその両方を指定して、公開プロフィールを1件解決します。
- 正規化された公開アカウント情報プロフィールID、ソースURL、ユーザー名、表示名、プロフィール文、アバター、カバー画像、ウェブサイトを一貫したアカウントレコードで返します。
- 観測時刻付きのアカウント指標取得可能な認証フラグと非公開フラグ、表示中のフォロワー数・フォロー数・投稿数、collected_at をまとめて、特定時点のプロフィールのスナップショットとして保持します。
Kwai Profile API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
username | 必須(いずれか1つ以上) | username または url のいずれかが必須です。ユーザー名は先頭に @ を付けることができ、その後にASCIIの英字、数字、ドット、アンダースコア、ハイフンからなる1〜64文字が続きます。 |
url | 必須(いずれか1つ以上) | url または username のいずれかが必須です。空でない参照は、解析すると kwai.com、kwai-video.com、またはそのいずれかのサブドメインのホスト名になる必要があります。オーソリティとホスト名があればスキームは問わず、プロトコル相対参照も受け付けます。 |
Kwai Profile API の使い方
対応する識別子を1つ送信して非同期タスクを追跡し、保存された結果ページから正規化プロフィールレコードを読み取ります。
- 有効なユーザー名、または解析後のホスト名が kwai.com、kwai-video.com、もしくはそのいずれかのサブドメインであるKwaiプロフィールの参照を用意します。
- username、url、またはその両方を /v1/kwai/profile に送信し、返された task_id を保存します。
- タスクが成功するか失敗を返すまで、/v1/tasks/{task_id} をポーリングします。
- data.results.items からプロフィールを読み取り、has_more が true の場合にのみ next_cursor をたどります。
curl -X POST "https://api.socq.ai/v1/kwai/profile" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.kwai.com/@ShortShortz8"}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor only while has_more is trueKwai Profile API の主なユースケース
- プロフィールレコードの補完: 既知のKwaiアカウントに紐づくレコードに、正規化された公開アカウント情報、プロフィール画像、ウェブサイト、アカウントフラグ、ソースURLを追加します。
- 表示中のアカウント指標の比較: 選定したプロフィール間で、取得可能なフォロワー数・フォロー数・投稿数を、リアルタイムの合計値としては扱わずに比較します。
- プロフィールのスナップショット監視: 繰り返し取得した結果を collected_at とともに保存し、公開アカウント情報のフィールド、アカウントフラグ、表示中の数値の経時変化を追跡します。
Kwai Profile API 活用のヒント
- 識別子を少なくとも1つ指定してください。username と url の両方がある場合、バックエンドはどちらか一方を選ぶのではなく、両方を転送します。
- 送信前に、ユーザー名を ^@?[A-Za-z0-9._-]{1,64}$ で検証し、解析後のURLのホスト名が kwai.com、kwai-video.com、またはそのサブドメインであることを確認してください。
- 公開プロフィールではスキーマの一部しか公開されていない場合があるため、プロフィール文、アバター、カバー画像、ウェブサイト、アカウントフラグ、個々の指標は任意項目として扱ってください。
- id を主な重複排除キーとして使用し、必要に応じて url で代替し、特定時点の指標スナップショットにはすべて collected_at を添えてください。
関連API
Kwai Profile API 以外に別の種類の公開Kwaiデータが必要な場合は、これらのAPIをご利用ください。
- Kwai User Posts API — ユーザー名または対応するプロフィールURLから公開Kwai投稿を1ページ分取得し、正規化されたコンテンツ、投稿者、メディア、タイムスタンプ、ハッシュタグ、メンション、表示中のエンゲージメントを返します。
- Kwai Post API — 既知の公開Kwai投稿URL 1件から、正規化されたコンテンツ、投稿者、メディア、タイムスタンプ、エンティティ、表示中のエンゲージメントの各フィールドを取得します。