リクエストの作成 | ドキュメント | Reverse WHOIS API | WhoisXML API

リクエストを出す

APIエンドポイント

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

Postman Collection

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

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

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

POSTリクエストボディの例

{
    "apiKey": "YOUR_API_KEY",
    "searchType": "current",
    "mode": "purchase",
    "punycode": true,
    "basicSearchTerms": {
        "include": [
            "Airbnb, Inc.",
            "US"
        ],
        "exclude": [
            "Europe",
            "EU"
        ]
    }
}

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

WHOISフィールドのいずれかに該当する単語を含むドメイン名が出力されます。

ヘッダー

X-Authentication-Token

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

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

入力パラメータ

apiKey

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

basicSearchTerms.include

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

basicSearchTerms.exclude

任意。検索文字列。いずれもドメイン名のWHOISデータに存在してはならないものです。最大4項目まで。大文字と小文字は区別されません。

searchType

任意。検索の種類。

current -  現在のWHOISレコードのみを検索します。

historic - 現在のWHOISレコードと過去のWHOISレコードの両方で検索します。

使用可能な値:currenthistoric

初期値:current

mode

任意

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

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

使用可能な値:previewpurchase

初期値:preview

punycode

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

使用可能な値:falsetrue

初期値:true

includeAuditDates

任意trueの場合、出力される各ドメイン名には、対応する監査日が追加されます。注:このパラメータは出力を変更します: ドメイン名の配列(falseの場合)->ドメイン名と監査日を含むオブジェクトの配列(trueの場合)。

API出力についての詳細はこちらをご覧ください。

使用可能な値:falsetrue

初期値:false

responseFormat

任意。応答の出力形式。

使用可能な値:jsonxml

初期値: 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形式の日付。

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

searchAfter

任意。応答は最大10,000レコードに制限されているため、このパラメータを使用すると、次のページを取得することができます。この値は、nextPageSearchAfter出力フィールドから取得する必要があります。結果に含まれる全てのドメイン名は、データベースに登場した日付の降順でソートされます。

無料アクセス

アカウントを登録後、限定500 DRSクレジットの無料サブスクリプションプランが適用されます。

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

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

このAPIは、専用のロードバランサーとプレミアムエンドポイントによりさらに高速なクエリを実現する強化版でもご用意しています。プレミアムAPIサービスおよびエンタープライズAPIパッケージの一部として提供されます。