{ "openapi": "3.0.1", "info": { "title": "ImportYeti Importer & Supplier Trade Explorer", "description": "Search ImportYeti by company, supplier, product, address, HS code, location or product tag; optionally open profiles for top trading partners, recent bills of lading, HS/HTS codes, shipping lanes, carriers, containers, notify parties and UFLPA flags.", "version": "1.0", "x-build-id": "8067cydD5JhF0oBDn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xyrelith-data~importyeti-company-and-supplier-shipment-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xyrelith-data-importyeti-company-and-supplier-shipment-lookup", "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/xyrelith-data~importyeti-company-and-supplier-shipment-lookup/runs": { "post": { "operationId": "runs-sync-xyrelith-data-importyeti-company-and-supplier-shipment-lookup", "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/xyrelith-data~importyeti-company-and-supplier-shipment-lookup/run-sync": { "post": { "operationId": "run-sync-xyrelith-data-importyeti-company-and-supplier-shipment-lookup", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byUrls", "byHsCodes", "byLocations", "byProductTags" ], "type": "string", "description": "What to scrape. Search matches names, product keywords and address text. URL, HS-code, location and product-tag modes read the corresponding ImportYeti pages directly.", "default": "search" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Company names, brands, product keywords, or address text (mode=search). One entry per search. ImportYeti searches names, indexed product text and address text; a trademark name works as a brand search, not a separate trademark index.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "ImportYeti URLs", "type": "array", "description": "Company, supplier, HS-code, location, product-tag or search URLs (mode=byUrls). Full https://www.importyeti.com/... links or paths such as company/apple are accepted.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "URL", "description": "Full ImportYeti URL or path, e.g. https://www.importyeti.com/company/apple." } } }, "default": [] }, "hsCodes": { "title": "HS codes", "type": "array", "description": "2-, 4- or 6-digit HS codes, e.g. 85, 8471, 8507.60, or full /hs-codes/... URLs (mode=byHsCodes). Each code returns its top suppliers, top US companies and recent shipments.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Country slugs such as china or vietnam, or full /location/... URLs for states, counties and cities (mode=byLocations). Bare slugs use the location type below.", "default": [], "items": { "type": "string" } }, "locationType": { "title": "Bare location type", "enum": [ "supplier", "company" ], "type": "string", "description": "Whether bare country slugs point at the overseas-supplier directory or the US-importer directory. Ignored for full location URLs.", "default": "supplier" }, "productTags": { "title": "Product tags", "type": "array", "description": "Product-tag slugs such as yoga-mat or lithium-battery, or full /tags/... URLs (mode=byProductTags).", "default": [], "items": { "type": "string" } }, "entityType": { "title": "Entity type", "enum": [ "any", "company", "supplier" ], "type": "string", "description": "Keep only US importers (companies), only overseas suppliers, or both. Search uses ImportYeti's own server-side type filter; HS, location and tag modes filter their supplier/company tables.", "default": "any" }, "shipmentRecency": { "title": "Most recent shipment within", "enum": [ "any", "3mo", "6mo", "12mo", "24mo" ], "type": "string", "description": "Keep only entities with a shipment in this window. ImportYeti's search API ignores this filter, so it is applied locally to the dates the source returns.", "default": "any" }, "minShipments": { "title": "Minimum shipments", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop entities with fewer than this many lifetime shipments. Applied locally.", "default": 0 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum records to return in this run. ImportYeti caps a search query at 280 reachable rows (140 per entity type); use more search queries for more. Every profile exposes at most 50 partners and 50 recent shipments.", "default": 25 }, "includeProfileDetails": { "title": "Open profiles for details", "type": "boolean", "description": "Open each matched company or supplier and return its trading partners, recent bills of lading and trade details. Adds one request per profile. Applies to search and URL modes; HS, location and tag pages already contain their tables.", "default": true }, "maxPartners": { "title": "Max partners per profile", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap the top-supplier or top-customer table per profile. ImportYeti exposes up to 50.", "default": 50 }, "maxShipments": { "title": "Max recent shipments per profile", "minimum": 0, "maximum": 50, "type": "integer", "description": "Cap the recent bill-of-lading rows per profile. ImportYeti exposes up to 50.", "default": 50 }, "includeTradeDetails": { "title": "Include trade details", "type": "boolean", "description": "Emit HS/HTS codes, port lanes, carriers, containers, notify parties, other addresses, tags and monthly history from the opened profile. Only applies when profile details are opened.", "default": 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 } } } } } } } } } }