encarapi 1.2.0 → 1.3.0

package/README.md

@@ -85,6 +85,15 @@ saveCursor(client.china.lastCursor);
 | `iterateCatalogById(params)` | `GET /api/catalog?sort=id` | Complete, stable traversal (keyset cursor, nothing repeated or skipped) |
 | `leasing(params)` | `GET /api/catalog/leasing` | Lease takeovers and rentals |
 | `iterateLeasingById(params)` | `GET /api/catalog/leasing?sort=id` | Complete, stable traversal of lease/rental listings |
+| `vehicleByVin(vin)` | `GET /api/vehicle/by-vin/{vin}` | All listings of one VIN incl. removed ones (Business/Scale) |
+| `trucks(params)` | `GET /api/catalog/trucks` | Trucks, buses and special vehicles (Business/Scale) |
+| `truckEnums()` | `GET /api/catalog/trucks/enums` | Truck filter values with counts |
+| `trucksCsv()` | `GET /api/catalog/trucks/export` | Full truck inventory CSV (Business/Scale) |
+| `iterateTrucksById(params)` | `GET /api/catalog/trucks?sort=id` | Complete, stable traversal of the truck catalog |
+| `equipment(params)` | `GET /api/catalog/equipment` | Used excavators (Business/Scale) |
+| `equipmentEnums()` | `GET /api/catalog/equipment/enums` | Equipment filter values with counts |
+| `equipmentCsv()` | `GET /api/catalog/equipment/export` | Full equipment inventory CSV (Business/Scale) |
+| `iterateEquipmentById(params)` | `GET /api/catalog/equipment?sort=id` | Complete, stable traversal of the equipment catalog |
 | `nav(params)` | `GET /api/nav` | Filter facets with counts |
 | `enums(params)` | `GET /api/enums` | Valid values for the flat filters |
 | `modelSearch(search, params)` | `GET /api/model-search` | Model autocomplete |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "encarapi",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Official Node.js client for EnCarAPI: Korean used car data (Encar, KB Chachacha, K Car) and Chinese used car data (Dongchedi, Che168) in one REST API.",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.d.ts

@@ -81,6 +81,58 @@ export interface KoreaCatalogParams {
   count?: Bool;
 }
 
+/** Filters for /api/catalog/trucks. Values from korea.truckEnums(). */
+export interface KoreaTruckParams {
+  form?: "cargo" | "wing_body" | "bus" | "dump_construction" | "crane" | "tank" | "camper" | "waste_transport" | "live_fish" | "tow_transport" | "tractor" | "trailer" | (string & {});
+  manufacturer?: string;
+  /** Substring of the Korean model name, e.g. "포터". */
+  model?: string;
+  min_tons?: number;
+  max_tons?: number;
+  use?: "private" | "commercial" | "other";
+  fuel?: string;
+  transmission?: string;
+  color?: string;
+  min_price?: number;
+  max_price?: number;
+  min_year?: number;
+  max_year?: number;
+  min_mileage?: number;
+  max_mileage?: number;
+  region?: string;
+  sort?: "newest" | "price_asc" | "price_desc" | "mileage_asc" | "mileage_desc" | "year_desc" | "year_asc" | "id";
+  after?: string;
+  page?: number;
+  limit?: number;
+  count?: Bool;
+  lang?: "en";
+}
+
+/** Filters for /api/catalog/equipment. Values from korea.equipmentEnums(). */
+export interface KoreaEquipmentParams {
+  maker?: string;
+  model?: string;
+  sub_type?: "crawler" | "wheel" | (string & {});
+  /** e.g. "EXC_CR_LE_6_5" (02 class crawler). */
+  weight_class?: string;
+  min_year?: number;
+  max_year?: number;
+  min_hours?: number;
+  max_hours?: number;
+  /** Price in 만원 (10,000 KRW). */
+  min_price?: number;
+  max_price?: number;
+  has_price?: Bool;
+  /** "sell" (default), "buy", "rent", a comma list or "all". */
+  deal_type?: string;
+  region?: string;
+  sort?: "newest" | "price_asc" | "price_desc" | "hours_asc" | "year_desc" | "year_asc" | "id";
+  after?: string;
+  page?: number;
+  limit?: number;
+  count?: Bool;
+}
+
 export interface KoreaCatalogResponse {
   Count?: number;
   SearchResults: Json[];
@@ -130,6 +182,24 @@ export class KoreaClient {
   iterateCatalogById(params?: KoreaCatalogParams): AsyncGenerator<Json, void, unknown>;
   /** iterateCatalogById() for lease-takeover and rental listings. */
   iterateLeasingById(params?: KoreaCatalogParams): AsyncGenerator<Json, void, unknown>;
+  /** Encar trucks, buses and special vehicles (Business/Scale). */
+  trucks(params?: KoreaTruckParams): Promise<KoreaCatalogResponse>;
+  /** Every Encar / K Car listing of one VIN, active and removed (Business/Scale). */
+  vehicleByVin(vin: string): Promise<Json>;
+  /** Valid truck filter values with counts. */
+  truckEnums(): Promise<Json>;
+  /** Full truck inventory as CSV text (Business/Scale). */
+  trucksCsv(params?: { compress?: Bool }): Promise<string>;
+  /** Complete, stable traversal of the truck catalog (sort=id + after). */
+  iterateTrucksById(params?: KoreaTruckParams): AsyncGenerator<Json, void, unknown>;
+  /** Used excavators from 굴삭기나라 (Business/Scale). */
+  equipment(params?: KoreaEquipmentParams): Promise<KoreaCatalogResponse>;
+  /** Valid equipment filter values with counts. */
+  equipmentEnums(): Promise<Json>;
+  /** Full equipment inventory as CSV text (Business/Scale). */
+  equipmentCsv(params?: { compress?: Bool }): Promise<string>;
+  /** Complete, stable traversal of the equipment catalog (sort=id + after). */
+  iterateEquipmentById(params?: KoreaEquipmentParams): AsyncGenerator<Json, void, unknown>;
   /** Ids: Encar id, "kbc:<id>" or "kcar:<id>". */
   vehicle(id: string, params?: { lang?: "en" }): Promise<Json>;
   inspection(id: string): Promise<Json>;

package/src/korea.js

@@ -64,6 +64,38 @@ class KoreaClient {
     yield* this._iterateById("/api/catalog/leasing", params);
   }
 
+  // -- trucks, buses, special vehicles (Business/Scale) ----------------------
+
+  /** Encar trucks & buses: { form: "cargo", max_tons: 1, lang: "en" }. Values from truckEnums(). */
+  trucks(params) { return this.http.request("GET", "/api/catalog/trucks", { params }); }
+
+  /** Valid truck filter values with counts (form, use, fuel, transmission, color, manufacturer, capacity_tons, region). */
+  truckEnums() { return this.http.request("GET", "/api/catalog/trucks/enums"); }
+
+  /** Full truck inventory as CSV text (Business/Scale). */
+  trucksCsv(params) { return this.http.request("GET", "/api/catalog/trucks/export", { params, text: true }); }
+
+  /** Complete, stable traversal of the truck catalog (sort=id + after). */
+  async *iterateTrucksById(params = {}) {
+    yield* this._iterateById("/api/catalog/trucks", params);
+  }
+
+  // -- construction equipment / excavators (Business/Scale) -----------------
+
+  /** Used excavators from 굴삭기나라: { sub_type: "crawler", max_hours: 5000 }. Values from equipmentEnums(). */
+  equipment(params) { return this.http.request("GET", "/api/catalog/equipment", { params }); }
+
+  /** Valid equipment filter values with counts (maker, sub_type, weight_class, deal_type, region). */
+  equipmentEnums() { return this.http.request("GET", "/api/catalog/equipment/enums"); }
+
+  /** Full equipment inventory as CSV text (Business/Scale). */
+  equipmentCsv(params) { return this.http.request("GET", "/api/catalog/equipment/export", { params, text: true }); }
+
+  /** Complete, stable traversal of the equipment catalog (sort=id + after). */
+  async *iterateEquipmentById(params = {}) {
+    yield* this._iterateById("/api/catalog/equipment", params);
+  }
+
   async *_iterateById(path, params) {
     const { page, ...rest } = params;
     let query = { ...rest, sort: "id", limit: params.limit || 1000 };
@@ -80,6 +112,9 @@ class KoreaClient {
   /** Full vehicle detail. Ids: Encar id, "kbc:<id>" or "kcar:<id>". */
   vehicle(id, params) { return this.http.request("GET", `/api/vehicle/${enc(id)}`, { params }); }
 
+  /** Every Encar / K Car listing of one VIN, active and removed (Business/Scale). */
+  vehicleByVin(vin) { return this.http.request("GET", `/api/vehicle/by-vin/${enc(vin)}`); }
+
   /** Official inspection report (성능점검). */
   inspection(id) { return this.http.request("GET", `/api/inspection/${enc(id)}`); }