中古車検索API
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | 物件ID | 物件に割り当てられた番号で検索します。 | *1 | *2 |
| brand | ブランドコード | ブランドで検索します。指定できるコードはブランドマスタAPIを参照。 | *1 | *2 |
| model | 車種名 | 車種名で検索(部分一致)します。 | *1 | |
| country | 国コード | ブランドの代表国で検索します。指定できるコードは国マスタAPIを参照。 | *1 | *2 |
| large_area | 大エリアコード | 中古車店の所在エリアから検索します。指定できるコードは大エリアマスタAPIを参照。 | *1 | *2 |
| pref | 都道府県コード | 中古車店の所在都道府県から検索します。指定できるコードは都道府県マスタAPIを参照。 | *1 | *2 |
| body | ボディタイプコード | ボディの形から検索します。指定できるコードはボディタイプマスタAPIを参照。 | *1 | *2 |
| person | 定員 | 指定した人数以上の定員の車を検索します。 | *1 | 整数(例)5 |
| color | カラーコード | 車の色で検索します。指定できるコードはカラーマスタAPIを参照。 | *1 | *2 |
| price_min | 最低価格 | 価格帯から検索します。 | (例)500000 | |
| price_max | 最高価格 | |||
| keyword | キーワード | ブランド名、車種名、モデル名、説明文、国、色のフリーワード検索(部分一致)が可能です。文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。 | *1 | |
| lat | 緯度 | ある地点からの範囲内の中古車店に在庫のある車の検索を行う場合の緯度です。 | *1 | (例) 35.669220 |
| lng | 経度 | ある地点からの範囲内の中古車店に在庫のある車の検索を行う場合の経度です。 | (例) 139.761457 | |
| range | 検索範囲 | ある地点からの範囲内の中古車店に在庫のある車の検索を行う場合の範囲を指定できます。単位km | 半角整数。最大200。指定なしは1 | |
| datum | 測地系 | 緯度・経度の測地系を指定できます。world: 世界測地系、tokyo: 旧日本測地系。初期値は world。 | (例) world | |
| mission | ミッション種類 | ATかMTかで絞り込みます。 | 1：AT 2：MT 指定なし：絞り込みなし |
|
| nonsmoking | 禁煙車 | 禁煙車で絞り込みます。 |
1:絞り込む 0:絞り込まない 初期値:0 |
|
| leather | 本革シート | 本革シートで絞り込みます。 | 1:絞り込む 0:絞り込まない 初期値:0 |
|
| welfare | 福祉車両 | 福祉車両で絞り込みます。 | 1:絞り込む 0:絞り込まない 初期値:0 |
|
| year_old | 登録年式(古い) | 登録年式で絞り込みます。 | 4桁の整数 (例)1998 |
|
| year_new | 登録年式(新しい) | |||
| odd_min | 走行距離(最短) | 走行距離で絞り込みます。単位Kmの整数 | (例)50000 | |
| odd_max | 走行距離(最長) | |||
| order | ソート順 | 検索結果の並び順を指定します。 | 0:ブランド順 1:価格安い順 2:価格高い順 3:車種名順 4:年式古い順 5:年式新しい順 6:走行距離少ない順 初期値はブランド順。位置から検索を行った場合は距離順 |
|
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
*2 複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
都道府県コード=13(東京)の中古車を検索
■地点を指定して、その範囲にある中古車を検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 47 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| usedcar | [複数要素] | |
| id | 物件ID | CH9999999999 |
| brand | ブランド | |
| code | ブランドコード | SB |
| name | ブランド名 | スバル |
| model | 車種名 | インプレッサ |
| grade | グレード名 | WRX STi |
| price | 本体価格 - 226000 のような数値か '応談' のような文字列のいずれか | 2260000 |
| inspection | 車検 | |
| maintenance | 整備 | カーセンサーnet [整備]を参照してください。 |
| warranty | 保証 | カーセンサーnet [保証]を参照してください。 |
| recycle | リサイクル | カーセンサーnet [リサイクル]を参照してください。 |
| engine | エンジン形式 | ガソリン |
| desc | 説明文 | |
| body | ボディタイプ | |
| code | ボディタイプコード | S |
| name | ボディタイプ名 | セダン |
| odd | 走行距離 | 43000Km |
| year | 登録年 | 2002 |
| shop | 取扱店 | |
| name | 店名 | カーセンサーオート |
| pref | 都道府県 | |
| code | 都道府県コード | 13 |
| name | 都道府県名 | 東京都 |
| lat | 緯度 | 35.660818 |
| lng | 経度 | 139.775426 |
| datum | 測地系 | world |
| color | ボディカラー | WRブルー |
| maintenance_comment | 整備に関するコメント | 当社提携の認証整備工場にて、１２ヶ月法定点検＋分解整備＋消耗品交換を行います。 |
| maintenance_fee | 整備にかかる金額(円) | 10000 |
| photo | 画像 | |
| main | メイン画像 | |
| l | メイン画像url(大) | |
| s | メイン画像url(小) | |
| caption | キャプション | |
| sub | [複数要素]その他画像url | |
| sub_img | [複数要素] その他画像 l(url)は photo/subと同じ。captionとして画像キャプションがレスポンスされます。 photo/subと重複しますが、キャプションを使う場合はsub_imgから取得してください。 |
|
| l | 画像url photo/subと同じ内容 | |
| caption | キャプション | |
| urls | 詳細ページURL | |
| pc | PC向けURL | |
| mobile | 携帯向けURL | |
| qr | QRコード画像へのURL 画像サイズ等の変更方法はこちら |
|
| warranty_comment | 保証に関するコメント | 新車メーカー保証付き（全国対応） |
| warranty_distance | 保証距離 | 保証距離：100000km |
| warranty_length | 保証期間 | 保証期間：6ヶ月 |
| warranty_fee | 保証費用(円) | 25000 |
カタログAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| brand | ブランドコード | ブランドで検索します。指定できるコードはブランドマスタAPIを参照。*2 | *1 | (例)SB |
| model | 車種名 | 車種名で検索(部分一致)します。 | *1 | (例)インプレッサ |
| country | 国コード | ブランドの代表国で検索します。指定できるコードは国マスタAPIを参照。*2 | *1 | (例)JPN |
| body | ボディタイプコード | ボディの形から検索します。指定できるコードはボディタイプマスタAPIを参照。*2 | *1 | (例)S |
| person | 定員 | 指定した人数以上の定員の車を検索します。 | *1 | 整数(例)5 |
| year_old | 販売年(から) | 販売年で絞り込みます。 | 4桁の整数 (例)1998 |
|
| year_new | 販売年(まで） | |||
| welfare | 福祉車両 | 福祉車両で絞り込みます。 | *1 | 1:絞り込む 0:絞り込まない(初期値) |
| series | 形式 | 車の形式で検索します。 | *1 | GF-GF8 |
| keyword | キーワード | ブランド名、車種名、モデル名、説明文、のフリーワード検索(部分一致)が可能です。文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。 | *1 | |
| width_max | 最大幅 | 車の寸法から検索します。単位mm。 | *1 | (例)1700 |
| height_max | 最大高さ | *1 | (例)1500 | |
| length_max | 最大長さ |
*1 | (例)4500 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:ブランド順 1:モデル名順 指定なし:ブランド順 |
|
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：30、最小1、最大30 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
*2 複数指定可能パラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
キーワード「インプレッサ」で検索
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 47 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 47 |
| results_start | 検索結果の開始位置 | 1 |
| catalog | [複数要素] | |
| brand | ブランド | |
| code | ブランドコード | SB |
| name | ブランド名 | スバル |
| model | 車種名 | レガシィツーリングワゴン |
| grade | グレード名 | 2.0GT |
| price | 価格 | 3030000 |
| desc | 説明文 | |
| body | ボディタイプ | |
| code | ボディタイプコード | W |
| name | ボディタイプ名 | ステーションワゴン |
| person | 定員 | 5 |
| period | 販売期間(販売中の場合は最後が999999） | 200705-999999 |
| series | 形式 | |
| width | 全幅 | 1730 |
| height | 全高 | 1470 |
| length | 全長 | 4680 |
| photo | 画像 | |
| front | 前面 | |
| caption | 説明 | |
| l | 画像(大) | |
| s | 画像(小) | |
| rear | 背面 | |
| caption | 説明 | |
| l | 画像(大) | |
| s | 画像(小) | |
| inpane | インパネ | |
| caption | 説明 | |
| l | 画像(大) | |
| s | 画像(小) | |
| urls | 店舗URL | |
| pc | PC向けURL | |
| mobile | 携帯向けURL | |
| qr | QRコード画像へのURL 画像サイズ等の変更方法はこちら |
|
| desc | 詳細フラグ。1の場合中古車検索API対象店舗 | 0:なし、1:あり |
ブランドマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | ブランドコード | コード指定で特定のブランドを取得します | LE | |
| country | 国コード | 国で絞り込むことができます。指定するコードは国マスタAPIを参照。 | ||
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 6 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 6 |
| results_start | 検索結果の開始位置 | 1 |
| brand | [複数要素] | |
| code | ブランドコード | |
| name | ブランド名 | |
| country | 代表国 | |
| code | 国コード | |
| name | 国名 |
国マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | 国コード | コード指定で特定の国を取得します | JPN | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 9 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 9 |
| results_start | 検索結果の開始位置 | 1 |
| country | [複数要素] | |
| code | 国コード | |
| name | 国名 | 関西 |
大エリアマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | 大エリアコード | コード指定で特定の大エリアを取得します | 3 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 47 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 47 |
| results_start | 検索結果の開始位置 | 1 |
| large_area | [複数要素] | |
| code | 大エリアコード | |
| name | 大エリア名 |
都道府県マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | 都道府県コード | コード指定で特定の都道府県を取得します | 02 | |
| large_area | 大エリアコード | 大エリアコードで検索します。*2 | ||
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 47 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 47 |
| results_start | 検索結果の開始位置 | 1 |
| pref | [複数要素] | |
| code | 都道府県コード | |
| name | 都道府県名 | |
| large_area | ||
| code | 大エリアコード | |
| name | 大エリア名 |
ボディタイプマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 47 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 47 |
| results_start | 検索結果の開始位置 | 1 |
| body | [複数要素] | |
| code | ボディタイプコード | |
| name | ボディタイプ名 |
カラーマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.20 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 530 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 530 |
| results_start | 検索結果の開始位置 | 1 |
| color | [複数要素] | |
| code | カラーコード | |
| name | カラー名 |
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/carsensor/">
<api_version>1.00</api_version>
<error>
<message>keyは必須パラメーターです</message>
</error>
</results>
エラーの際でも、HTTPレスポンスステータスは常に "200 OK" が返ります。実装側では常にレスポンスXMLの内容を見てエラー判断を行ってください。
Flashからの利用方法
Flash Action Script 2.0にて本APIを利用するには1フレーム目に下記の記述を追加する必要があります:
System.security.loadPolicyFile("http://webservice.recruit.co.jp/carsensor/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
