リクエストを出す | ドキュメント | Registrant Alert API | WhoisXML API

リクエストを出す

APIエンドポイント

POST https://registrant-alert.whoisxmlapi.com/api/v2
アカウントの登録後、有効化に1分ほどかかります。

検索結果は10,000レコードに制限されています。より適切な検索結果を得たい場合は、検索クエリを最適化するか、高度な検索を使用してみてください。

Postman Collection

Postmanは、GUIからAPIへのリクエストを可能にするデスクトップおよびウェブのアプリケーションです。APIの機能を活用する際、およびアプリケーションのトラブルシューティングにあたっては、PostmanとWhoisXML APIエンドポイントのご利用をお勧めします。

WhoisXML API Postman Collectionは、以下のリンクから入手できます:

コレクションの環境はあらかじめ設定されたものです。各リクエストを起動するためには、api_key変数を設定する必要があります。 個人用API KEYは、My productsページで取得してください。APIに関するご質問は、こちらにお送りください。

POSTリクエスト本文の例

{
    "apiKey": "API_KEY",
    "sinceDate": "2019-04-20",
    "mode": "purchase",
    "punycode": true,
    "basicSearchTerms":
    {
        "include": [
            "Airbnb",
            "US"
        ],
        "exclude": [
            "Europe",
            "EU"
        ]
    }
}

1回のリクエストで最大4つのインクルード検索語とエクスクルード検索語を指定できます。複数のインクルード/エクスクルード検索語を指定すると、インクルード語を全て含み、エクスクルード語を1つも含まないドメイン名が出力されます。

出力には、以下のフィールドのいずれかに単語が含まれている登録者によって追加または失効されたドメイン名が含まれます:

RegistrantContactフィールド

RegistrantContact.City, RegistrantContact.Country, RegistrantContact.Email, RegistrantContact.Fax, RegistrantContact.FaxExtension, RegistrantContact.Name, RegistrantContact.Organization, RegistrantContact.PostalCode, RegistrantContact.State, RegistrantContact.StreetAddress, RegistrantContact.Telephone, RegistrantContact.TelephoneExtension

ヘッダー

X-Authentication-Token

APIコールには、このヘッダーまたはapiKeyパラメータを使用できます。

My productsページで個人用APIキーを取得してください。

入力パラメータ

apiKey

必須My productsページでAPI KEYを取得してください。

basicSearchTerms.include

必須。検索文字列の配列。全てドメイン名の登録者のデータに存在している必要があります。最大4項目。大文字と小文字は区別されません

basicSearchTerms.exclude

任意。検索文字列の配列。これら全てがドメイン名の登録者データに存在しない必要があります。最大4項目。大文字と小文字は区別されません。

sinceDate

任意。「YYYY-MM-DD」形式の日付。

許可される日付は、[今日マイナス14日-今日]間隔です。

初期値は昨日の日付です。

なお、昨日の結果は通常午前10-12時(UTC)に発表される。

存在する場合、指定された日付以降に発見された活動を検索します。実際の追加日/更新日/失効日とシステムが変更を検出した日付との間に待ち時間が発生することがあります。毎日の変更をフィルタリングするために、貴社の監視ツールでこのフィールドを使用することをお勧めします。

mode

任意

preview:ドメイン数のみを返します。クレジットは差し引かれません。

purchase:実際のドメイン名のリストを返します(10,000個まで)。1リクエストにつき10 DRSクレジットが必要です。

使用可能な値:preview | purchase

初期値:preview

punycode

任意trueの場合、応答の中のドメイン名はPunycodeにエンコードされます。

使用可能な値:falsetrue

初期値:true

responseFormat

任意。応答の出力形式。

使用可能な値:json | xml

初期値:json

createdDateFrom

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付以降に作成されたドメイン名を検索します。

createdDateTo

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付より前に作成されたドメイン名を検索します。

updatedDateFrom

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付以降に作成されたドメイン名を検索します。

updatedDateTo

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付より前に更新されたドメイン名を検索します。

expiredDateFrom

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付以降に期限切れとなったドメイン名を検索します。

expiredDateTo

任意。「YYYY-MM-DD」形式の日付。

存在する場合、指定された日付より前に期限切れとなったドメインを検索します。

無料アクセス

アカウントの登録後、500 DRSクレジットまで無料になるサブスクリプションプランが自動的に適用されます。

使用量の上限とリクエストのスロットリング

1秒あたりのリクエスト数の上限は30件です。この上限を超えた場合、 次のまでリクエストは拒否されます。

プレミアムAPIサービスおよびエンタープライズAPIパッケージでご提供するAPIでは、専用のロードバランサーとプレミアムエンドポイントにより、さらに高速なクエリが可能です。

高度な検索のAPIドキュメント

高度な検索では、具体的なWHOISフィールドを検索することができます。