premiumphonenumber_townpage
企業情報検索
タウンページデータベースを用いた企業情報検索を行います。
タウンページデータベースとは、NTT東日本様・NTT西日本様が発行する職業別電話帳(タウンページ)に
収録されている情報をデータ化した商品です。
個人商店から大企業までの情報を網羅的に収録し、約1,900業種の業種分類を設定しています。
-
企業フリーワード検索
企業名を指定してフリーワードで検索できます。
-
電話番号検索
電話番号を指定して検索できます。
-
業種検索
業種分類を指定して検索できます。
指定できる業種分類についてはこちらをご確認ください。
-
範囲指定検索
市区町村や円範囲を指定して検索できます。
※検索条件を複数指定した場合はAND結合となります
※本APIを利用するには別途契約が必要です。
※タウンページデータベースの業種分類一覧の閲覧を希望される場合は営業担当にお問い合わせください。
HTTP request method
POST/GET
ContentType
application/x-www-form-urlencoded
Parameters
*requiredは必須
Array型のパラメータの区切り文字は特記のない限りカンマ(,)およびセミコロン(;)です。
名前 | 説明 |
---|---|
telephone_id string |
電話番号IDを指定 完全一致。 ※現在利用できないリクエストパラメーターです。指定された場合、エラーは返却されず無視されます。 |
zid string |
建物ZIDを指定
建物等の地物毎にふられるパーマネントのID。 |
zid_attr string |
属性ZIDを指定
建物や地物内のテナント施設等といった属性情報毎にふられるパーマネントのID。 |
id string |
ID(地物)を指定
建物ZIDを0パディングし22桁に揃えた文字列。 |
id_attr string |
ID(属性)を指定
属性ZIDを0パディングし22桁に揃えた文字列。 |
word string |
タウンページ掲載名称、読みを指定 最大文字数は1024です。 複数ワードはスペース区切りで指定。AND結合となります。 |
word_match_type integer default 3 |
検索語句のマッチタイプを指定
|
jgdc_address_code_list array[string] |
住所コードを指定 市区町村コード5桁までを指定。前方一致。 複数指定可。複数指定の場合はOR結合となります。 |
phone_number string |
電話番号を指定 完全一致。 ハイフン有無に関わらずどちらでも検索可能です。 |
post_code string |
郵便番号を指定 完全一致。 ハイフン有無に関わらずどちらでも検索可能です。 |
address string |
住所を指定 部分一致。 |
address_care_of string |
住所方書を指定 部分一致。 |
base_class_code array[string] |
基本分類コードを指定 複数指定可。 指定可能な値はこちらを参照してください。 |
base_class_name string |
基本分類名称を指定 部分一致。 指定可能な値はこちらを参照してください。 |
ntt_industry_code array[string] |
NTT業種分類コードを指定 複数指定可。 指定可能な値はこちらを参照してください。 |
ntt_industry_name string |
NTT業種分類名称を指定 部分一致。 指定可能な値はこちらを参照してください。 |
company_type_code array[string] |
法人種類コードを指定 完全一致。 複数指定可。 指定可能な値はレスポンスのcompany_type_codeを参照してください。 |
proximity array[number] ※カンマ区切り |
中心座標、半径で範囲を指定 代表点の近傍検索。 ”経度,緯度,半径(m)"で指定してください。 半径の上限は5000です。 |
sort array[string] |
出力順を指定(複数指定可) デフォルトは昇順で、降順指定の場合、ソートキーの前⽅にマイナス(-)を付加します。 デフォルト指定はありません(順不同)。
|
facet array[string] |
分類ごとの件数を取得するファセットフィールド名を指定
|
limit array[integer] ※カンマ区切り default List[0,100] |
検索結果取得件数を"オフセット,件数”で指定 最大値 2000,1000 |
datum string default JGD |
入出力座標の測地系を指定 JGD
世界測地系
TOKYO
日本測地系
TOKYO_NAVI
日本測地系(ゼンリン ナビ地図)
|
Responses
エラーについては「エラーメッセージ一覧」を参照してください。
Media type:application/json
キー名 | 説明 | ||
---|---|---|---|
|
ステータス | ||
|
|
hit integer |
検索結果総数 |
|
|||
base_class_facet string number |
facetの指定がある場合のみ出力 基本分類コード:名称,件数の配列。 |
||
ntt_industry_facet string number |
facetの指定がある場合のみ出力 NTT業種分類コード:名称,件数の配列。 |
||
|
|||
zid string |
建物ZID 建物等の地物毎にふられるパーマネントのID |
||
zid_attr string |
属性ZID 地物内のテナント施設等といった属性情報毎にふられるパーマネントのID |
||
id string |
ID(地物) 建物ZIDを0パディングし22桁に揃えた文字列 | ||
id_attr string |
ID(属性) 属性ZIDを0パディングし22桁に揃えた文字列 | ||
phone_name string |
電話番号名称 漢字掲載名を主掲載/副掲載1/副掲載2/副掲載3/副掲載4の形式で出力します。 例)AA株式会社/BB支店/CC部/aa課/bb係
|
||
phone_name_read string |
電話番号名称読み カナ掲載名を主掲載/副掲載1/副掲載2/副掲載3/副掲載4の形式で出力します。 例)
|
||
phone_number string |
電話番号 電話番号を出力します。 例)
|
||
post_code string |
郵便番号 | ||
address string |
住所 | ||
address_care_of string |
住所方書 | ||
address_code2 string |
都道府県コード | ||
address_code3 string |
市区町村コード | ||
base_class_code string |
基本分類コード | ||
base_class_name string |
基本分類名称 | ||
ntt_industry_code string |
NTT業種分類コード | ||
ntt_industry_name string |
NTT業種分類名称 | ||
phone_number_mark string |
電番略符号 電番略符号2桁コード。セミコロン(;)で区切ります。 例) 06;12 (FAX専用と代表電話)
|
||
company_type_code string |
法人種類コード 掲載名中の法人種類名により、法人種類コードを出力します。
|
||
external_char_type string |
外字識別表示
|
||
popular_name_flag string |
通称識別フラグ 住所が通称か正規かを出力します。
|
||
matching_level string |
マッチングレベル
|
||
position array[number] |
座標。'[経度,緯度]' | ||
distance number |
検索座標と代表点の直線距離 proximityを指定した場合のみ返却されます。 |
Example
https://[domain]/search/phonenumber_townpage?word=%E3%83%AF%E3%83%86%E3%83%A9%E3%82%B9&word_match_type=3&facet=base_class_facet,ntt_industry_facet&limit=0,100&datum=JGD
{
"status": "OK",
"result": {
"info": {
"hit": 15
},
"facet": {
"base_class_facet": [
"0221:穀類・めん類・パン・菓子",
1,
"0231:和風飲食店",
2,
"0232:洋風・中華飲食店",
4,
"0920:各種商品小売業",
5,
"1020:医薬及び医療機械器具",
1,
"1110:クリーニング・理容・浴場",
1,
"1280:写真・デザイン・装飾",
1
],
"ntt_industry_facet": [
"0385000:飲食店",
1,
"2323000:コンビニエンス店",
3,
"3033000:画像加工・写真プリント",
1,
"3501000:スーパーストア",
2,
"3977000:エステティック",
1,
"6033000:パン店",
1,
"7809000:薬局",
1,
"8469000:上海料理",
1,
"8482000:すし店",
1,
"8547000:レストラン",
3
]
},
"item": [
{
"zid": "000000000000000000",
"zid_attr": "000000000000000000",
"id": "0000000000000000000000",
"id_attr": "0000000000000000000000",
"phone_name": "○○お茶の水ワテラス店",
"phone_name_read": "○○オチヤノミズワテラステン",
"phone_number": "0335254366",
"post_code": "101-0063",
"address": "東京都千代田区神田淡路町X丁目105",
"address_care_of": "ワテラスアネックスX階",
"address_code2": "13",
"address_code3": "101",
"base_class_code": "0232",
"base_class_name": "洋風・中華飲食店",
"ntt_industry_code": "8469000",
"ntt_industry_name": "上海料理",
"phone_number_mark": null,
"company_type_code": "99",
"external_char_type": "0",
"popular_name_flag": "0",
"matching_level": "SAA",
"position": [
139.76782333,
35.6975275
],
"distance": null
},
...
]
}
}