{ "openapi": "3.0.1", "info": { "title": "ImportYeti Scraper — US Customs Bill of Lading & Supplier Data", "description": "Scrape US customs bill-of-lading & supplier trade data by company, supplier, product or HS code. Extract per-shipment BOL records with importer & supplier names, addresses, countries, products, weights and contacts. Keyless, no login.", "version": "1.0", "x-build-id": "OxrCawkJUC7ruqn23" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~importyeti-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-importyeti-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/logiover~importyeti-scraper/runs": { "post": { "operationId": "runs-sync-logiover-importyeti-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/logiover~importyeti-scraper/run-sync": { "post": { "operationId": "run-sync-logiover-importyeti-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "Mode", "enum": [ "companySearch", "supplierSearch", "companyShipments", "productSearch" ], "type": "string", "description": "What to scrape.\n\n• **companySearch** — start from an importer (US buyer) and pull every bill of lading on its profile, then crawl its suppliers for thousands more shipments (highest volume)\n• **supplierSearch** — start from a foreign supplier/manufacturer and pull its shipments + the US companies it ships to\n• **companyShipments** — bills of lading for the exact company/supplier profile(s) you name, with no graph crawl (fast, precise)\n• **productSearch** — crawl the trade graph and keep only shipments whose product description or HS code matches your keyword", "default": "companySearch" }, "query": { "title": "Company / supplier / product", "type": "string", "description": "Free-text seed. A company or supplier name (e.g. `Nike`), an ImportYeti profile URL, a profile slug (e.g. `nike`), or — in productSearch — a product keyword (e.g. `furniture`, `led lighting`). Leave empty for a broad default." }, "companySlug": { "title": "Company slug or URL", "type": "string", "description": "A single importer profile — its ImportYeti slug (e.g. `nike`) or full URL (`https://www.importyeti.com/company/nike`). Used by companySearch, companyShipments and productSearch (as the crawl seed)." }, "companySlugs": { "title": "Company slugs / URLs (batch)", "type": "array", "description": "Several importer profiles at once (slugs or URLs). One per line.", "items": { "type": "string" }, "default": [] }, "supplierSlug": { "title": "Supplier slug or URL", "type": "string", "description": "A single foreign supplier profile — slug (e.g. `pou-sung-vietnam`) or full URL (`https://www.importyeti.com/supplier/pou-sung-vietnam`). Used by supplierSearch and companyShipments." }, "supplierSlugs": { "title": "Supplier slugs / URLs (batch)", "type": "array", "description": "Several supplier profiles at once (slugs or URLs). One per line.", "items": { "type": "string" }, "default": [] }, "hsCode": { "title": "HS / HTS code (productSearch)", "type": "string", "description": "Optional Harmonized System code to filter shipments (any length prefix, e.g. `9403` for furniture, `6110` for sweaters). Combined with the product keyword." }, "includeCompanySummary": { "title": "Also emit a company summary row", "type": "boolean", "description": "When on, each crawled profile also yields one company-summary row (also-known names, HS codes, top suppliers, totals) alongside its per-shipment rows. Turn off for pure BOL output.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Upper bound on rows returned. Drives how far the graph crawl fans out. A single profile embeds up to 50 bills of lading, so the crawler visits more profiles until this many rows are collected (or the ~4-minute time budget is hit).", "default": 500 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "ImportYeti sits behind a Cloudflare Managed Challenge; a US RESIDENTIAL proxy is required to pass it (the default already does). Do not force the DATACENTER group.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }