{
  "openapi": "3.0.1",
  "info": {
    "title": "ImportYeti Scraper - US Import Records, Suppliers & B2B Leads",
    "description": "Scrape ImportYeti US Customs bill-of-lading data. Find US importers and their overseas suppliers, full shipment history, HS/HTS codes, carriers, ports, China & UFLPA risk flags, and contact leads. New-shipment monitoring. No login or browser.",
    "version": "0.1",
    "x-build-id": "NVbnrfxuNh2pPfw93"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~importyeti-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~importyeti-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-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/scrapesage~importyeti-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "product",
              "company",
              "supplier"
            ],
            "type": "string",
            "description": "What to scrape:\n\n• **Search & discover** — match US importers and/or overseas suppliers by company name or brand, and (by default) pull a full trade profile for each.\n• **Product** — find every US importer (and overseas supplier) of a product keyword (`yoga mat`, `lithium battery`), with shipment volumes — the fastest way to build a buyer list for what you sell.\n• **Company (US importer)** — resolve each term/URL to a US importer and return its full profile.\n• **Supplier (overseas)** — resolve each term/URL to a foreign supplier/exporter and return its full profile.",
            "default": "search"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "What to look up. In **Search / Company / Supplier** modes use company names or brands (`Apple`, `Walmart`, `Anker`). In **Product** mode use product keywords (`yoga mat`, `lithium battery`, `office chair`) to list everyone importing/exporting that product. In Company/Supplier modes each term resolves to the single best-matching entity of that type.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "ImportYeti URLs",
            "type": "array",
            "description": "Optional. Paste ImportYeti **company** or **supplier** page URLs to scrape them directly — e.g. `https://www.importyeti.com/company/apple` or `https://www.importyeti.com/supplier/hon-hai-precision-industrial`. Search-result URLs (`/search?q=...`) are also accepted and treated as search terms.",
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Result type (search mode)",
            "enum": [
              "all",
              "company",
              "supplier"
            ],
            "type": "string",
            "description": "In Search mode, keep only US importers, only overseas suppliers, or both.",
            "default": "all"
          },
          "enrichProfiles": {
            "title": "Pull full profile for each hit (search mode)",
            "type": "boolean",
            "description": "In Search mode, open every matched entity and return its **full trade profile** (supplier/buyer list, shipment history, HS/HTS codes, carriers, ports, growth, contacts). Turn OFF for a fast, cheap discovery list only (name, type, country, total shipments, most-recent shipment, trademarks, profile URL).",
            "default": true
          },
          "includeSuppliers": {
            "title": "Include supplier / buyer table",
            "type": "boolean",
            "description": "Include the full counterparty table — every overseas supplier of a US importer (or every US buyer of a supplier) with address, country, shipment counts, weight, TEUs, HS codes, top trade partners and Alibaba links.",
            "default": true
          },
          "includeShipments": {
            "title": "Include recent shipments (bills of lading)",
            "type": "boolean",
            "description": "Include the most recent individual bill-of-lading shipment records: date, BOL / master BOL / house BOL, counterparty, product description, weight, containers, quantity, shipping route and estimated freight cost.",
            "default": true
          },
          "includeHsCodes": {
            "title": "Include HS / HTS code breakdown",
            "type": "boolean",
            "description": "Include the HS code tree (chapter → heading → subheading with shipments/weight/TEUs) and the detailed HTS codes with sample product descriptions.",
            "default": true
          },
          "includeContacts": {
            "title": "Include contact leads (emails / phones)",
            "type": "boolean",
            "description": "Extract real (non-masked) contact emails and phone numbers from the company's known addresses and notify-party records, plus the list of all known addresses. Great for building a sales-prospecting list.",
            "default": true
          },
          "maxSuppliers": {
            "title": "Max suppliers/buyers per profile",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Cap the counterparty (supplier/buyer) table per profile.",
            "default": 50
          },
          "maxShipments": {
            "title": "Max shipments per profile",
            "minimum": 0,
            "maximum": 200,
            "type": "integer",
            "description": "Cap the recent bill-of-lading shipment records per profile.",
            "default": 50
          },
          "maxResults": {
            "title": "Max results (whole run)",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Global cap on the total number of records (profiles or discovery rows) emitted in this run.",
            "default": 50
          },
          "maxResultsPerSearch": {
            "title": "Max hits per search term",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Cap the number of entities taken from each search term's results (ImportYeti returns roughly the top 10–25 matches per term).",
            "default": 20
          },
          "monitorMode": {
            "title": "Monitoring mode — only new & updated",
            "type": "boolean",
            "description": "Remember the entities returned in previous runs and emit ONLY those that are **new** or have **received new shipments** since the last run (tagged `changeType`: new / updated, with `newShipmentsSinceLastRun`). Perfect for watching competitors' imports or a supplier's customers. Pairs with Apify Schedules — it does not conflict with the scheduler; the schedule triggers the run, this flag controls what is emitted.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' entities for monitoring mode. Use a different name per watchlist to keep histories separate (lowercase letters, digits and hyphens).",
            "default": "importyeti-monitor"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum parallel requests. Keep it moderate to stay friendly to ImportYeti's servers.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. ImportYeti sits behind Cloudflare and can challenge datacenter IPs, so **US residential proxies are the reliable default**. Datacenter proxies are cheaper and may work for light use — switch to them to cut cost if your runs come back full.",
            "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}