Bulk WHOIS API ユーザーガイド(旧版) | ドキュメント | Bulk WHOIS API | WhoisXML API

Bulk WHOIS API ユーザーガイド(旧)

Bulk Whois APIは、ドメイン名/IPアドレスのリストに対するWHOISレコードを1件のREST APIクエリで提供します。このAPIは、標準的なHTTPまたはHTTPSプロトコルを使用して、お客様のシステムとWhoisXmlApi.comネットワークとの間のサーバー間通信用に設計されています。クエリの応答は、POSTメソッドで行われるお客様のリクエストに基づいて、XMLまたはJSON形式で配信されます。

始めるには、WhoisXmlApi.comのアカウントが必要です。 APIを利用するには毎回認証が必要となります。無料アカウントを登録すると、最初の 500件のBulk Whois APIコールが無料になります。

Bulk WHOIS APIウェブサービスを呼び出す

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/bulkWhois

リクエストのボディにJSONエンコードされたパラメータを指定し、Content-Typeヘッダ をapplication/jsonに設定します。サーバーのレスポンスには、要求されたWHOISレコードを取得するために必要なrequestIdフィールドが含まれています。

JSON応答の例

{
  "domains": [
    "google.com",
    "yahoo.com"
  ],
  "username": "your_username",
  "password": "********",
  "outputFormat": "JSON"
}

入力パラメータ

domains

必須。WHOISデータをリクエストするドメイン名。

username

必須。あなたのアカウントのユーザー名。

password

必須。アカウントのパスワード。

特殊文字(&、%、*など)が含まれている場合は、URLエンコードされていることを確認してください。

outputFormat

応答の出力形式。

使用可能な値:JSON XML

初期値:XML

出力の例

{
  "noDataAvailable": false,
  "message": "OK",
  "messageCode": 200,
  "requestId": "ece0f949-c22a-4ecc-..."
}

WHOISレコードを取得

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getRecords

全ての入力ドメインの処理には時間がかかる場合があるため、返されるrecordsLeftフィールドの値が0になるまで、このリソースを繰り返しクエリする必要があります。

各レコードの進行状況を監視する必要がない場合は、maxRecords入力パラメータを 1に設定します。

上記の設定をしなかった場合、whoisRecords配列の各要素にwhoisRecordStatusフィールドが含まれます:

  • 0 - 処理済み;
  • 1/2 - 不完全/欠落データ;
  • 3 - 処理中。

JSONのリクエストの例

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "maxRecords": 1,
  "username": "your_username",
  "password": "********",
  "startIndex": 1,
  "outputFormat": "JSON"
}

入力パラメータ

username

必須。あなたのアカウントのユーザー名。

password

必須。アカウントのパスワード。

特殊文字(&、%、*など)が含まれている場合は、URLエンコードされていることを確認してください。

requestId

必須。文字列。

Bulkリクエストの識別子。

maxRecords

必須。数字。

返すWHOISレコードの最大数。

startIndex

任意。数字。

サーバーから返される最初のWHOISレコード。

使用可能な値:1+

初期値:1

outputFormat

任意。応答の出力形式。

使用可能な値:JSON XML

初期値:XML

結果のCSVのダウンロード

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/download

JSONのリクエストの例

{
  "requestId": "ece0f949-c22a-4ecc-...",
  "username": "your_username",
  "password": "********",
  "searchType": "all"
}

入力パラメータ

username

必須。あなたのアカウントのユーザー名。

password

必須。アカウントのパスワード。

特殊文字(&、%、*など)が含まれている場合は、URLエンコードされていることを確認してください。

requestId

必須。文字列。

Bulkリクエストの識別子。

searchType

任意。文字列。

noErrorで、処理エラーやデータのないレコードをフィルタリングできます。

使用可能な値:allnoError

初期値:all

リクエスト一覧の取得

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getUserRequests

JSONのリクエストの例

{
  "noDataAvailable": false,
  "userRequests": [
    {
      "requestId": "f1008d3e-7774-495b-...",
      "time": 1498282373092,
      "status": "Completed",
      "totalRecords": 4,
      "fetchedRecords": 0
    }
  ]
}

入力パラメータ

username

必須。あなたのアカウントのユーザー名。

password

必須。アカウントのパスワード。

特殊文字(&、%、*など)が含まれている場合は、URLエンコードされていることを確認してください。

outputFormat

任意。応答の出力形式。

使用可能な値:JSON XML

初期値:XML

無料アクセス

アカウントを登録すると、500件まで無料となるサブスクリプションプランが自動的に適用されます。