{ "openapi": "3.0.1", "info": { "title": "ImportYeti Scraper — US Customs Importer & Supplier Data", "description": "Search ImportYeti US Customs records for importer and supplier profiles: name, type, country, address, total shipments and latest shipment date, plus top suppliers or buyers, HS codes, port lanes and recent bills of lading. Filter by country, type and shipment count.", "version": "0.2", "x-build-id": "01t04syferwswcHJk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~importyeti-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-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/khadinakbar~importyeti-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-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/khadinakbar~importyeti-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-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": { "searchQueries": { "title": "Search queries", "uniqueItems": true, "type": "array", "description": "Free-text company names or product keywords (e.g., 'Patagonia', 'YETI Coolers', 'phone case', 'lithium battery'). Each query is sent to the ImportYeti search API and paginated up to maxResultsPerQuery records. Leave empty if you only have direct profile URLs.", "items": { "type": "string" } }, "startUrls": { "title": "ImportYeti profile URLs", "type": "array", "description": "Direct ImportYeti profile URLs (https://www.importyeti.com/company/{slug} or https://www.importyeti.com/supplier/{slug}). Each URL is resolved to a single matching record via the search API. NOT a search-results URL — use the canonical profile URL.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResultsPerQuery": { "title": "Max profiles per search query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum profiles to return per searchQueries entry. The API returns 10 results per page; the actor paginates internally until this cap is hit or no more pages are available. Bounded 1–500. Default 10. Each pushed profile is billed at the per-profile event price.", "default": 10 }, "countryCode": { "title": "Country code filter (optional)", "type": "string", "description": "Optional ISO-3166-1 alpha-2 country code (e.g., 'US', 'CN', 'VN') to restrict results to that country. Applied after fetching — filters out profiles registered in other countries. Leave empty for no country filter." }, "typeFilter": { "title": "Importer / supplier filter", "enum": [ "both", "company", "supplier" ], "type": "string", "description": "Restrict results to US importers ('company') only, foreign suppliers ('supplier') only, or return both ('both'). Default 'both'.", "default": "both" }, "minShipments": { "title": "Minimum total shipments filter", "minimum": 0, "type": "integer", "description": "Drop records with fewer than this number of total bills-of-lading on file. Use to filter out inactive or tiny companies. Default 0 (no filter).", "default": 0 }, "enrichProfile": { "title": "Add profile rollups", "type": "boolean", "description": "When on (default), each saved profile also gets its ImportYeti rollups: top suppliers or buyers, top HS codes, top port lanes, tags and recent bills of lading. Adds one profile-page request per row; billed under the same profile-scraped event. Turn off for faster, card-only rows.", "default": true }, "maxShipmentsPerProfile": { "title": "Recent bills of lading per profile", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many of the most recent bills of lading to include in recentShipments when enrichProfile is on, for example 10. Range 0 to 50 (the profile page lists up to 50). Default 10. Not a cap on profiles; use maxResultsPerQuery for that.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used to hit the ImportYeti API. Defaults to Apify residential US — the cleanest IP reputation. The API is rate-limited per IP, so rotating residential IPs maximizes throughput on long runs.", "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 }, "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 } } } } } } } } } }