{ "openapi": "3.0.1", "info": { "title": "ImportYeti Scraper & API - US Import Records, Bills of Lading", "description": "ImportYeti scraper and US import records API: US importers and their overseas suppliers from customs bills of lading, by product, company or URL. One row = address, website, shipments (total, 12 months), top suppliers, HS codes, origin countries, carriers, lanes. $0.45 per 1,000, no start fee.", "version": "1.0", "x-build-id": "W9DW0jfZnX76iciZT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~importyeti-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-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/rel8ble~importyeti-scraper/runs": { "post": { "operationId": "runs-sync-rel8ble-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/rel8ble~importyeti-scraper/run-sync": { "post": { "operationId": "run-sync-rel8ble-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": { "queries": { "title": "Keywords or company names", "type": "array", "description": "What to search for on ImportYeti, one search per line: a product (\"yoga mats\", \"solar panels\", \"lithium batteries\"), a company (\"lululemon\", \"costco wholesale\") or a brand. Each line is one search; results are merged. Typical: 1-50 lines. Leave empty when you give startUrls instead.", "items": { "type": "string" } }, "startUrls": { "title": "ImportYeti page URLs", "type": "array", "description": "Optional. Company or supplier report pages, one per line: \"https://www.importyeti.com/company/lululemon-usa\", \"https://www.importyeti.com/supplier/travancore-mats-and-matting\" (or just \"company/lululemon-usa\"). Each gives one full result with details, no search needed.", "items": { "type": "string" } }, "entityType": { "title": "Importers, suppliers or both", "enum": [ "all", "company", "supplier" ], "type": "string", "description": "\"all\" (default) returns both US importers (type \"company\") and overseas suppliers (type \"supplier\"). \"company\" = US importers only (lead lists of companies that import the product). \"supplier\" = overseas manufacturers / exporters only (sourcing lists).", "default": "all" }, "includeDetails": { "title": "Include the full report", "type": "boolean", "description": "Default true: open each result's report page (one request each) and add website, aliases, other addresses, first / last shipment, 12-month shipments, top suppliers or customers with HS codes and product descriptions, HS code breakdown, origin countries, carriers, trade lanes (ports), shipments per year and month, bill types and container types. False = search rows only (name, address, country, total shipments, last shipment, URL), which is about 10x faster.", "default": true }, "minShipments": { "title": "Minimum total shipments", "minimum": 0, "type": "integer", "description": "Skip importers / suppliers with fewer sea shipments than this in ImportYeti's records. E.g. 10 removes one-off importers from a lead list. 0 = keep everything.", "default": 0 }, "activeSinceYear": { "title": "Last shipment in or after (year)", "type": "string", "description": "Optional. Keep only companies whose most recent shipment is in this year or later, e.g. \"2025\" for currently active importers." }, "countries": { "title": "Country codes", "type": "array", "description": "Optional. Keep only results in these countries (2-letter codes): e.g. \"US\" for importers, or \"CN\", \"VN\", \"IN\", \"TR\" for suppliers. Empty = any country.", "items": { "type": "string" } }, "maxItemsPerQuery": { "title": "Max results per query", "minimum": 0, "type": "integer", "description": "Stop each query after this many results (after filters). 0 = everything ImportYeti finds. Default 100.", "default": 100 }, "maxItems": { "title": "Max results in total", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many results. 0 = no limit. Default 1000 (= $0.45). The run also stops cleanly at the \"Maximum cost per run\" you set.", "default": 1000 }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many requests to run at once. Default 2; ImportYeti rate-limits per IP, so higher values mostly mean more retries.", "default": 2 }, "maxRequestRetries": { "title": "Retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "How often a failed request is retried on a new session / IP before it is given up. Default 10.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Default: Apify Proxy (datacenter). ImportYeti counts requests per IP, so every few requests use a fresh proxy IP. Residential is not needed.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }