{
  "openapi": "3.0.1",
  "info": {
    "title": "ImportYeti Scraper - 100+ Fields, US Import Bills of Lading",
    "description": "Scrape US import records from ImportYeti by company name, address or HS code: importers, overseas suppliers, top partners, HS codes, lanes, carriers, UFLPA flag, freight cost estimate and the 50 latest bills of lading. 100+ fields per profile or flat rows. No login. Empty pages are never charged.",
    "version": "0.1",
    "x-build-id": "CD5h4GKy1bIgYyIxM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapewise~importyeti-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapewise-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/scrapewise~importyeti-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapewise-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/scrapewise~importyeti-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapewise-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": {
          "searchTerms": {
            "title": "Search by company or supplier name",
            "type": "array",
            "description": "Company or supplier names, one per line, for example walmart, hon hai or yeti coolers. ImportYeti searches US importers ('company' pages) and overseas shippers ('supplier' pages) by name, like its own search box; product words are not a product search (use 'HS codes' for that). Each search returns up to 'Max results per search' hits, which are opened as full profiles or turned into rows according to 'What to return'. A name with no hit returns a free NO_RESULTS row. Also accepts 'query', 'searchQuery', 'searchQueries', 'search' and 'keyword'.",
            "items": {
              "type": "string"
            }
          },
          "urls": {
            "title": "ImportYeti links",
            "type": "array",
            "description": "ImportYeti pages, one per line: https://www.importyeti.com/company/apple, https://www.importyeti.com/supplier/foxconn-interconnect-technology, a path such as company/apple, or an HS code page (/hs-codes/847330). Each link returns one profile, or its partners or bills of lading as rows, see 'What to return'. Links are always opened, whatever the filters. Unknown pages return a free NOT_FOUND row. Also accepts 'startUrls', 'companies' and 'suppliers'.",
            "items": {
              "type": "string"
            }
          },
          "addressSearch": {
            "title": "Search by address",
            "type": "array",
            "description": "Street, city or industrial-zone text, one per line, for example shenzhen longhua or 1710 w baseline rd. Finds the importers and suppliers registered at that address, up to 'Max results per search'. Useful to map every factory in an industrial park or to find other companies at a supplier's address.",
            "items": {
              "type": "string"
            }
          },
          "hsCodes": {
            "title": "HS codes",
            "type": "array",
            "description": "Product codes, one per line: a 2-digit chapter (84), 4-digit heading (8471) or 6-digit subheading (8473.30 or 847330); longer HTS codes are cut to 6 digits. Each code returns US import totals since 2015, top origin countries, the 50 largest US importers and overseas suppliers of that code, and the 50 latest bills of lading, in one row charged as a full profile (US$ 3.00 per 1,000). With 'What to return' set to partners or bills of lading, those lists come as flat rows instead. Invalid codes return a free INVALID_HS_CODE row.",
            "items": {
              "type": "string"
            }
          },
          "resultType": {
            "title": "What to return",
            "enum": [
              "profiles",
              "profilesAndShipments",
              "searchResults",
              "partners",
              "shipments"
            ],
            "type": "string",
            "description": "Full profiles (default, US$ 3.00 per 1,000): totals, first and last shipment, top 50 partners, partners by HS code, HS/HTS codes, shipping lanes, carriers, notify parties and the 50 latest bills of lading, in one row. Full profile + bills of lading: the same row plus every bill of lading as its own row (US$ 2.00 per 1,000). Search results only: name, country, address and total shipments, without opening each page; the cheapest way to map who exists. Trading partners and Recent bills of lading: flat rows ready for a spreadsheet (US$ 2.00 per 1,000)."
          },
          "maxResultsPerSearch": {
            "title": "Max results per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many hits to take from each name or address search, in ImportYeti's order (10 per page), up to 1,000. Empty means 10. In Trading partners and Recent bills of lading modes this is the number of profiles opened per search, and each profile can give up to 50 rows, so 10 profiles can produce 500 rows. Has no effect on pasted links or HS codes."
          },
          "maxItems": {
            "title": "Max rows in total",
            "minimum": 0,
            "type": "integer",
            "description": "Hard cap on charged rows for the whole run (profiles, search rows, partner rows and bill-of-lading rows together), for example 200. Use it to limit spend in partner and shipment modes, where one profile can give 50 rows. Empty or 0 means no cap besides the per-search limit. Also accepts 'limit'."
          },
          "entityType": {
            "title": "Only this kind",
            "enum": [
              "all",
              "company",
              "supplier"
            ],
            "type": "string",
            "description": "Keep only US importers (company pages) or only overseas suppliers (supplier pages) from name and address searches. Empty or 'Importers and suppliers' keeps both. Links you paste are always opened. Skipped hits are not charged. Also accepts 'searchType' or 'type' (company, supplier, importer, consignee, shipper, exporter)."
          },
          "countries": {
            "title": "Only these countries",
            "type": "array",
            "description": "Two-letter country codes of the hit, one per line, for example US, CN, VN, IN or MX. Search hits from other countries are skipped and not charged. Empty keeps every country. Example: CN and VN with 'Only this kind' set to suppliers to list factories in those two countries.",
            "items": {
              "type": "string"
            }
          },
          "minShipments": {
            "title": "Min total shipments",
            "minimum": 0,
            "type": "integer",
            "description": "Skip search hits with fewer total ocean shipments on record than this, for example 100 to drop one-off shippers and small importers. Empty keeps every hit. Skipped hits are not charged."
          },
          "mostRecentShipment": {
            "title": "Shipped recently",
            "enum": [
              "any",
              "3mo",
              "6mo",
              "12mo",
              "24mo"
            ],
            "type": "string",
            "description": "Keep only search hits with at least one shipment in this period: last 3, 6, 12 or 24 months. Use it to find companies that are actively trading and to skip dormant ones. Empty or 'Any time' keeps every hit. Skipped hits are not charged."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify datacenter proxy (the default) works for ImportYeti. Every page is fetched from a fresh IP, and refused requests are retried on another IP before becoming a free BLOCKED row. Change it only if you have a reason to use another proxy group.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}