API
APIはウェブサイトと同じ検索を実行し、結果をデータとして返します。形式は初期設定ではJSONで、XML、CSV、TSV、NDJSON、プレーンテキストも選べます。すべて読み取り専用の操作で、何かを作成したり変更したりすることはありません。
ベースURL
https://api.publicwww.com
コマンド1つで実行
curl -H "Authorization: Bearer $KEY" \
"https://api.publicwww.com/v1/search?query=%22angular.min.js%22&per_page=3"
{
"query": "\"angular.min.js\"",
"page": 1,
"per_page": 3,
"total": 278,
"total_pages": 93,
"returned": 3,
"truncated": false,
"took_ms": 2,
"results": [
{ "domain": "imgbox.com", "url": "https://imgbox.com/", "rank": 4187, "ranked": true }
]
}
エンドポイント
| エンドポイント | メソッド | 機能 |
|---|---|---|
/v1/search |
GET, POST | 検索を実行します。パラメーター、形式。 |
/v1/account |
GET | プラン、利用枠、上限。利用枠は消費しません。 |
/mcp |
POST | AIアシスタントやエージェント向けのMCPサーバー。同じ検索をツールとして、同じトークンで利用できます。 |
/ |
GET | エラーコードを含むAPI自身の説明。キーは不要です。 |
/openapi.json |
GET | 同じ内容をOpenAPI 3.1の記述として提供します。Postman、n8n、Make、Power Automateなどのツールにインポートできます。キーは不要です。 |
エクスポート専用のエンドポイントはありません。大量取得には、per_pageを大きくして/v1/searchを使います。有料プランでは最大100万行まで指定でき、レスポンスは生成されるそばからストリーミングで返されます。
APIが約束すること
-
結果が黙って減らされることはありません。ブラウザでは、1日の利用枠を使い切るとウェブサイトは自動的に無料プランの上限に切り替わり、表示件数が減ります。スクリプトにはそれがわからないため、APIでは短い結果を完全なものに見せかけて返すのではなく、
429 quota_exceededエラーを返します。 -
結果が途中で打ち切られた場合は、そのことが明示されます。どの形式でも、本文には
truncatedが、ヘッダーにはX-Truncatedが付きます。 -
順位のないサイトはそう明示されます。
rank: nullとranked: falseが返されます。クライアントが実在する非常に大きな順位と誤解しかねない内部のプレースホルダー値が返されることはありません。 -
待たせるより、待つよう伝えます。リクエストが速すぎる場合は、接続を保留するのではなく、
Retry-After付きのレスポンスをすぐに返します。
キーの取得
アカウントページでトークンを発行するか、OAuth 2.1を使ってアプリケーションに取得させます。有料プランが必要です。料金をご覧ください。旧?export=URLを呼び出す既存のスクリプトは、変更なしでそのまま動作します。詳しくは旧エクスポートURLをご覧ください。