{ "openapi": "3.0.1", "info": { "title": "ImportYeti Scraper: US Customs Records, Suppliers & Importers", "description": "Scrape ImportYeti US customs data on importers and suppliers: profiles, bill of lading shipments, supplier-to-customer links and port lanes. Search by name, HS code, product or country, load whole lists, and get only new shipments on every scheduled run. No login. Export to Excel, CSV or JSON.", "version": "0.1", "x-build-id": "47SD3FLcgxnlOkPZZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~importyeti-suppliers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-importyeti-suppliers-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/getascraper~importyeti-suppliers-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-importyeti-suppliers-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/getascraper~importyeti-suppliers-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-importyeti-suppliers-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": { "searchQueries": { "title": "Search names or products", "type": "array", "description": "Company names, supplier names or product words to search for, one per row, for example nike or led lighting. Each row returns up to the value of Max results per lookup (150 is the most the site serves per search). Leave every lookup field empty to run a small sample search.", "default": [], "items": { "type": "string" } }, "searchBy": { "title": "Search by", "enum": [ "name", "address" ], "type": "string", "description": "Choose whether the search rows above match names and products, or the address a company or supplier ships from or to, such as atlanta or ho chi minh.", "default": "name" }, "profiles": { "title": "Company or supplier profiles", "type": "array", "description": "Known profiles to load in full, one per row. Use a link, a path such as supplier/foxconn-interconnect-technology, or a bare name like apple (the importer is tried first). This is the cheapest way to enrich a list you already have.", "default": [], "items": { "type": "string" } }, "hsCodes": { "title": "HS codes", "type": "array", "description": "Product classification codes of 2 to 10 digits, for example 8504 or 8504.40. Each one returns the biggest importers and suppliers of that product, the latest shipments and the market totals.", "default": [], "items": { "type": "string" } }, "productTags": { "title": "Product keywords", "type": "array", "description": "Single product words as they appear in shipment descriptions, for example hdmi or carpet. Each one returns the biggest importers and suppliers shipping goods described with that word. The tags field on a profile lists words that are known to work; a word with no page is reported and skipped.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Supplier countries or location pages", "type": "array", "description": "A country name such as vietnam (lists foreign suppliers there), or a full ImportYeti location or port link for a state, city or port. Each one returns the biggest suppliers or importers based there.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Any ImportYeti links", "type": "array", "description": "Paste importyeti.com links of any supported page type (company, supplier, HS code, product keyword, location or port). Each link is recognised automatically.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "entityType": { "title": "Importer or supplier", "enum": [ "any", "supplier", "company" ], "type": "string", "description": "Keep only overseas suppliers, only US importers, or both. Applied to search results and to bare profile names.", "default": "any" }, "mostRecentShipment": { "title": "Shipped within", "enum": [ "any", "6mo", "12mo" ], "type": "string", "description": "Keep only entities whose latest customs record is within this window. Useful to drop dormant companies from lead lists.", "default": "any" }, "minShipments": { "title": "Minimum total shipments", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Skip entities with fewer customs records than this. Use it to separate regular traders from one-off buyers.", "default": 0 }, "countryCodes": { "title": "Countries (two-letter codes)", "type": "array", "description": "Keep only entities based in these countries, for example VN, IN or US. Leave empty to allow every country.", "default": [], "items": { "type": "string" } }, "marketRoles": { "title": "Rankings to return for HS codes, keywords and locations", "enum": [ "both", "importers", "suppliers" ], "type": "string", "description": "HS code, keyword, location and port pages list up to 50 top importers and 50 top suppliers. Choose which side you want.", "default": "both" }, "fetchProfiles": { "title": "Load full profiles", "type": "boolean", "description": "Open every matched company or supplier and return its full profile: addresses, HS codes, carriers, notify parties, trademarks and volume trends. Slower than plain search cards because each profile is one more page load.", "default": false }, "includeShipments": { "title": "Include shipment records", "type": "boolean", "description": "Add one row per bill of lading for each profile, with date, bill numbers, supplier or importer, weight, quantity, containers, product description, trade route and estimated freight cost. The site shows the 50 latest per profile. For HS code and keyword lookups this returns the latest shipments in that market.", "default": false }, "includePartners": { "title": "Include supplier and customer links", "type": "boolean", "description": "Add one row per trading partner of each profile: an importer's suppliers or a supplier's customers, with shipments together, last 12 months, volumes, HS codes and the partner's other big buyers. This is the supplier-to-customer map.", "default": false }, "includeTradeLanes": { "title": "Include port-to-port lanes", "type": "boolean", "description": "Add one row per shipping lane (departure port to US arrival port) with shipments, year-on-year change, weight, containers and estimated cost.", "default": false }, "includeTimeSeries": { "title": "Include monthly history", "type": "boolean", "description": "Add the month-by-month shipment counts to profiles and partner rows. Makes rows larger.", "default": false }, "onlyNewShipments": { "title": "Only new shipments and partners since last run", "type": "boolean", "description": "Remember what each profile or market already returned and, on later runs, return only shipment rows and trading partners that have not been seen before. The first run returns everything and saves the baseline. Schedule the Actor daily or weekly to watch competitors, customers or suppliers.", "default": false }, "monitorId": { "title": "Monitor name", "type": "string", "description": "A label for this watch. Use different names for different schedules so each keeps its own memory of what was already delivered.", "default": "default" }, "maxItems": { "title": "Max rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on rows saved in the whole run, across every row type. Free plans are capped at 25 per run.", "default": 10 }, "maxResultsPerSource": { "title": "Max results per lookup", "minimum": 1, "maximum": 150, "type": "integer", "description": "How many matches to keep for each search row and for each side of an HS code, keyword or location ranking. The site serves at most 150 matches per search.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Datacenter proxies work for this site and keep runs cheap. Every request uses a fresh exit address. If the site refuses datacenter addresses the Actor retries through residential ones automatically.", "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 } } } } } } } } } }