{
  "openapi": "3.0.1",
  "info": {
    "title": "ImportYeti Scraper | Suppliers, Importers and Bills of Lading",
    "description": "ImportYeti scraper and API for US customs data, import data and customs records by HS code, company or product: supplier finder, importer list, trading partners, shipment data, HTS codes, shipping lanes, carriers, bill of lading (BOL) data and phones. Alternative to Panjiva, ImportGenius and Volza.",
    "version": "1.0",
    "x-build-id": "q70qEqyVsoTZYCWNd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~importyeti-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-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/silentflow~importyeti-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-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/silentflow~importyeti-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-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 terms",
            "type": "array",
            "description": "Company names, supplier names or product keywords. Each term is searched on its own and returns its own rows.<br><br>Examples:<br>- <code>porsche</code>: Porsche and the companies that trade with it<br>- <code>hdmi cable</code>: importers and suppliers of HDMI cables<br>- <code>Shenzhen</code>: with <b>Search by</b> set to <b>Address</b>, businesses located there<br><br>A realistic product keyword returns a few hundred companies and suppliers.",
            "items": {
              "type": "string"
            }
          },
          "hsCodes": {
            "title": "📦 HS codes",
            "type": "array",
            "description": "Harmonized System codes, written any common way: <code>8507.60</code>, <code>850760</code> or a chapter like <code>85</code>. Each code returns the top US importers and overseas suppliers of that product, best first, up to 100 per code.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 ImportYeti URLs",
            "type": "array",
            "description": "Paste ImportYeti pages:<br>- a company or supplier profile (<code>https://www.importyeti.com/company/tesla</code>) returns that one business<br>- a search page (<code>https://www.importyeti.com/search?q=solar</code>) runs that search<br>- an HS code, place or port page returns the businesses it ranks<br><br>Filters do not apply to profile URLs: you named the business you want.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "searchType": {
            "title": "🧭 Search by",
            "enum": [
              "search",
              "addresses"
            ],
            "type": "string",
            "description": "<b>Name</b> searches company names, supplier names and product keywords. <b>Address</b> searches by place (city, state, street) and goes deeper: up to 10,000 results per term instead of 140.",
            "default": "search"
          },
          "type": {
            "title": "🏭 Business type",
            "enum": [
              "any",
              "supplier",
              "company"
            ],
            "type": "string",
            "description": "<b>Supplier</b>: overseas manufacturers and exporters. <b>Company</b>: US importers. <b>Both</b> returns each kind; on a large name search they are read separately, which doubles the reachable results to 280.",
            "default": "any"
          },
          "mostRecentShipment": {
            "title": "📅 Shipped within",
            "enum": [
              "any",
              "1mo",
              "3mo",
              "6mo",
              "12mo",
              "24mo"
            ],
            "type": "string",
            "description": "Keep only businesses with a shipment in this period. A supplier that stopped shipping a year ago is rarely a usable lead.",
            "default": "any"
          },
          "minShipments": {
            "title": "📊 Minimum shipments",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only businesses with at least this many shipments on record. Filters out one-time and low-volume importers."
          },
          "maxItems": {
            "title": "🔢 Max results per term, code or list",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum rows for each search term, each HS code and each list URL. Profile URLs always return their one row.<br><br>What ImportYeti serves: up to 140 per name search (280 with <b>Both</b>), up to 10,000 per address search, up to 100 per HS code.",
            "default": 100
          },
          "debugMode": {
            "title": "🐞 Debug mode",
            "type": "boolean",
            "description": "Write detailed logs.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}