{ "openapi": "3.0.1", "info": { "title": "ImportYeti Scraper - US Customs Import Records", "description": "Every ocean shipment into the US arrives with a manifest naming the importer and its shipper. ImportYeti indexes them: shipment counts, products, HS codes, origin and destination ports, first and last shipment dates. One row per partner, bill of lading or company.", "version": "0.1", "x-build-id": "fc1fNXWIrHlsOpLy8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~importyeti-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~importyeti-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~importyeti-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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": "Company or product terms", "type": "array", "description": "What to look up on ImportYeti. A brand or importer name (\"Nike\", \"Home Depot\"), a supplier name, or a product (\"solar panels\", \"lithium battery\"). One per line.", "items": { "type": "string" } }, "startUrls": { "title": "ImportYeti URLs", "type": "array", "description": "Optional. Paste ImportYeti company pages (https://www.importyeti.com/company/nike), supplier pages (https://www.importyeti.com/supplier/apl-logistics-vietnam) or search pages (https://www.importyeti.com/search?q=nike). Works alongside the search terms above.", "items": { "type": "string" } }, "resultType": { "title": "What each row should be", "enum": [ "partners", "shipments", "profiles", "search" ], "type": "string", "description": "Trading partners = one row per supplier/buyer relationship (about 45 per company). Shipments = one row per bill of lading, with dates and BOL numbers. Company profiles = one wide row per company with the partner list, ports and HS codes nested. Search results = just the matching companies, no profile pages opened.", "default": "partners" }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on rows returned across the whole run. You are charged per row returned; failed and skipped profiles are never charged.", "default": 200 }, "maxProfilesPerQuery": { "title": "Profiles to open per search term", "minimum": 1, "maximum": 50, "type": "integer", "description": "ImportYeti returns many name variants for one brand (Nike, Nike Usa, Nike Canada...). This is how many of them to actually open. Ignored when \"What each row should be\" is set to search results.", "default": 3 }, "includeUnnamedPartners": { "title": "Include unnamed counterparties", "type": "boolean", "description": "US customs manifests are sometimes filed with the counterparty blank, and ImportYeti shows those as \"Missing in source document\". Off by default so you are not charged for rows with no name.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The actor already rotates its own egress, which is what keeps ImportYeti's per-address page limit from stopping the run. Only set this if you must exit from a specific network." } } }, "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 } } } } } } } } } }