企業データ同業他社と競合企業API
POST
APIの稼働状況
- 24時間の稼働状況
- 正常
- 24時間の平均応答時間
- —
- 良好/正常
- 利用可能
- 制限あり
- ほぼ停止
正常
過去24時間
過去30日間
ドメインを指定して、企業の直接の同業他社と大手競合企業を一覧表示します。各社には、どのように競合しているかの短い説明が付きます。
料金は1,000リクエストあたり$20(1回あたり$0.02)です。失敗した呼び出しと空の結果には課金されません。 同期処理です。時間のかかるジョブでは、ボディに"mode": "async"を追加し、job_idを取得してポーリングしてください。
AIプロンプト
EveryInfraの企業データ 同業他社と競合企業エンドポイント(company_data/peers)を使ったデータ収集スクリプトの作成を手伝ってください。
エンドポイントの仕組み:
- リクエスト:ヘッダーにAuthorization: Bearer <API key>を指定して、https://api.everyinfra.com/api/v1/socialにPOSTします。APIキーは環境変数EVERYINFRA_API_KEYから読み込み、ハードコードしないでください。
- リクエストボディでplatformにcompany_data、actionにpeersを指定し、パラメータはparamsの中に入れます。
- 必須パラメータ:
- domain: 企業のドメインまたはWebサイトのリンクです(例:stripe.com、https://www.notion.com/)。スキーム、www.、パスは除去されます。ドメイン以外の値は課金前に拒否されます。
- 任意パラメータ:
- limit: この呼び出しで返す最大行数で、1〜50の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値を指定すると、課金前に422が返されます。(デフォルト:20)
- レコードのリストを返します。各レコードの主なフィールド: name(データセットに記載されたままの会社名またはブランド名(enrichでは小文字の…)、description(会社の事業内容)、peer_type(問い合わせた会社との関係(peers)).
- リクエストボディの例:
{
"platform": "company_data",
"action": "peers",
"params": {
"domain": "stripe.com"
}
}
- 料金:1,000リクエストあたり$20。失敗時および結果が空の場合は課金されません。
- 対象が数十〜数百件ある場合は、ボディに"mode": "async"を追加します。すぐにjob_idが返されるので、GET https://api.everyinfra.com/api/v1/jobs/{job_id}をポーリングして結果を取得します。
- 422の場合は、エラーに含まれる推奨パラメータ名と指定可能な値を使ってリクエストを修正します。429または503の場合は、Retry-Afterの指定に従って待ってから再試行します。
コードを書く前に、必要な対象とその件数、必要なフィールド、希望する出力形式を私に質問してください。そのうえで、計画と概算費用を私に確認してください。リクエストパラメータ
| 名前 | 場所 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
Authorization | header | string | はい | - | Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。 |
platform | body | string | はい | company_data | プラットフォームの識別子です。値は固定です。 |
action | body | string | はい | peers | 機能の識別子です。値は固定です。 |
domain | body.params | string | はい | - | 企業のドメインまたはWebサイトのリンクです(例:stripe.com、https://www.notion.com/)。スキーム、www.、パスは除去されます。ドメイン以外の値は課金前に拒否されます。 |
limit | body.params | integer (1–50) | いいえ | 20 | この呼び出しで返す最大行数で、1〜50の整数で指定します。省略するとデフォルト値が適用されます。また、返される行数がこれより少なくなる場合があります。最大値を超える値を指定すると、課金前に422が返されます。 |
コードサンプル
bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
-H "Authorization: Bearer $EVERYINFRA_API_KEY" \
-H 'Content-Type: application/json' \
--data-raw '{
"platform": "company_data",
"action": "peers",
"params": {
"domain": "stripe.com"
}
}'OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。
レスポンス例
フィールドプレビュー
このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。
json
{
"id": "req_…",
"platform": "company_data",
"action": "peers",
"results": [
{
"name": …,
"description": …,
"peer_type": …,
"platform": …
}
],
"count": …,
"billing": {
"charged": …,
"charged_usd": …,
"balance_after_usd": …,
…
},
"quota": { … }
}レスポンスフィールド
業務データはresultsに含まれます。この表はレコードに含まれうるフィールドの一覧です。プラットフォームに表示されない値を作り出すことはありません。
| フィールド | 意味 |
|---|---|
name | データセットに記載されたままの会社名またはブランド名(enrichでは小文字のことがよくあります)。 |
description | 会社の事業内容。peersでは、問い合わせた会社とどう競合しているかを示します。 |
peer_type | 問い合わせた会社との関係(peers)。direct_peerやbroad_incumbentなど。 |
platform | 取得元プラットフォームの識別子で、リクエストのplatformと同じです(例:xiaohongshu、tiktok)。 |
エラーと課金
- 401
- キーが未指定か無効です。
- 402
- 残高が不足しています。先にチャージしてください。
- 422
- パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
- 429
- 1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
- 503
- 処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
- 200(空)
- データがありません。課金はされません。