KYC不要 — 身分証明書、セルフィー、書類は不要です。暗号資産でお支払いいただけます。
言語: 日本語
1 GBを選択

APIリファレンス

APIキーとIP許可リスト

権限を制限したAPIキーを作成・失効できます。また、ユーザー名とパスワードなしでプロキシを利用できる送信元IPを最大10個まで、IP許可リストで管理できます。

4 分で読めます

このページのエンドポイント

  • GET /v1/api-keys：APIキーの一覧を取得
  • POST /v1/api-keys：APIキーを作成
  • DELETE /v1/api-keys/{keyId}：APIキーを取り消す
  • GET /v1/ip-whitelist：IP許可リストを取得
  • POST /v1/ip-whitelist：IPまたは範囲を許可リストに追加
  • DELETE /v1/ip-whitelist/{entryId}：許可リストから項目を削除

ベースURL https://localserpproxy.com/api/v1。認証、エラー、制限についてはAPI概要を参照してください。

APIキーの一覧を取得

GET/v1/api-keys

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

レスポンス 200 OK

{
  "data": [
    {
      "id": "key_5n2v8q",
      "name": "Rotation script",
      "prefix": "pk_4f9a2c",
      "scopes": [
        "read",
        "proxies"
      ],
      "createdAt": "2026-10-05T14:03:11Z",
      "lastUsedAt": null
    }
  ],
  "limit": 20
}

コード例

curl
curl -s "https://localserpproxy.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY"
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/api-keys", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

APIキーを作成

POST/v1/api-keys

secret全額を返金します。

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

リクエストボディ

フィールド型必須説明
namestringはい最大60文字
scopesarray of read · proxies · billingはい—
例
{
  "name": "Rotation script",
  "scopes": [
    "read",
    "proxies"
  ]
}

レスポンス 201 Created

{
  "id": "key_5n2v8q",
  "name": "Rotation script",
  "prefix": "pk_4f9a2c",
  "scopes": [
    "read",
    "proxies"
  ],
  "createdAt": "2026-10-05T14:03:11Z",
  "lastUsedAt": null,
  "secret": "pk_4f9a2c8e1b7d3f6a9c2e5b8d1f4a7c0e"
}

コード例

curl
curl -s -X POST "https://localserpproxy.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rotation script","scopes":["read","proxies"]}'
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/api-keys", headers=HEADERS, json={"name": "Rotation script", "scopes": ["read", "proxies"]}, timeout=30)
r.raise_for_status()
print(r.json())
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Rotation script', scopes: ['read', 'proxies'] }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

APIキーを無効化

DELETE/v1/api-keys/{keyId}

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

パラメーター

名前場所型必須説明
keyIdpathstringはい—

レスポンス 204 No Content

ボディなし：ステータスコードが回答です。

コード例

curl
curl -s -X DELETE "https://localserpproxy.com/api/v1/api-keys/key_5n2v8q" \
  -H "Authorization: Bearer $API_KEY"
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/api-keys/key_5n2v8q", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/api-keys/key_5n2v8q`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

IP許可リストを表示

GET/v1/ip-whitelist

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

レスポンス 200 OK

{
  "data": [
    {
      "id": "ipw_8c1k2m",
      "cidr": "203.0.113.24",
      "label": "Office server",
      "createdAt": "2026-10-05T14:03:11Z"
    }
  ],
  "limit": 10
}

コード例

curl
curl -s "https://localserpproxy.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY"
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/ip-whitelist", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

IPアドレスまたは範囲を許可リストに追加

POST/v1/ip-whitelist

IPv4アドレス、/24〜/32のIPv4 CIDR、IPv6アドレス、または/48〜/128のIPv6 CIDRに対応しています。プライベート、ループバック、予約済みの範囲は拒否されます（422）。ゲートウェイに60秒以内に反映されます。

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

リクエストボディ

フィールド型必須説明
cidrstringはい—
labelstringいいえ最大60文字
例
{
  "cidr": "203.0.113.24",
  "label": "Office server"
}

レスポンス 201 Created

{
  "id": "ipw_8c1k2m",
  "cidr": "203.0.113.24",
  "label": "Office server",
  "createdAt": "2026-10-05T14:03:11Z"
}

コード例

curl
curl -s -X POST "https://localserpproxy.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cidr":"203.0.113.24","label":"Office server"}'
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/ip-whitelist", headers=HEADERS, json={"cidr": "203.0.113.24", "label": "Office server"}, timeout=30)
r.raise_for_status()
print(r.json())
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ cidr: '203.0.113.24', label: 'Office server' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

許可リストからエントリを削除

DELETE/v1/ip-whitelist/{entryId}

認証：Authorization: Bearer API_KEYヘッダーにAPIキーを指定します。

パラメーター

名前場所型必須説明
entryIdpathstringはい—

レスポンス 204 No Content

ボディなし：ステータスコードが回答です。

コード例

curl
curl -s -X DELETE "https://localserpproxy.com/api/v1/ip-whitelist/ipw_8c1k2m" \
  -H "Authorization: Bearer $API_KEY"
Python
import os
import requests

API = "https://localserpproxy.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/ip-whitelist/ipw_8c1k2m", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done
Node.js
// Node.js 18+ (built-in fetch), ES module
const API = 'https://localserpproxy.com/api/v1';

const res = await fetch(`${API}/ip-whitelist/ipw_8c1k2m`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

1 GB $1.50 · KYC不要

料金を見る