{
  "openapi": "3.0.1",
  "info": {
    "title": "ImportYeti US Import Records, Supplier & Importer Leads Scraper",
    "description": "US importers and foreign suppliers of any product, HS code or country from ImportYeti's customs records: shipments, HS codes, carriers and website, contacts optional.",
    "version": "0.0",
    "x-build-id": "KEVCbnOyr52uxnddg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapebench~importyeti-us-customs-supplier-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapebench-importyeti-us-customs-supplier-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/scrapebench~importyeti-us-customs-supplier-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapebench-importyeti-us-customs-supplier-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/scrapebench~importyeti-us-customs-supplier-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapebench-importyeti-us-customs-supplier-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": [
              "product",
              "location",
              "profile"
            ],
            "type": "string",
            "description": "product: the US importers and the foreign suppliers of a product keyword or HS code. location: the suppliers ImportYeti lists in a country. profile: one named company or supplier.",
            "default": "product"
          },
          "query": {
            "title": "Query",
            "type": "string",
            "description": "product: a keyword ('hdmi cable', 'lithium battery') or an HS code ('850760', '8507.60'). location: a country ('china', 'vietnam'). profile: a company or supplier name ('nike usa'), slug, or ImportYeti URL. Any ImportYeti directory or profile URL also works."
          },
          "queries": {
            "title": "Queries (batch)",
            "type": "array",
            "description": "Several queries in ONE run, all in the chosen mode. Combined with 'Query'; duplicates are removed. 'Maximum results' applies per query.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "entityType": {
            "title": "Importers, suppliers or both",
            "enum": [
              "any",
              "importer",
              "supplier"
            ],
            "type": "string",
            "description": "product mode: keep only US importers, only foreign suppliers, or both (interleaved). Location pages list suppliers only.",
            "default": "any"
          },
          "activeOnly": {
            "title": "Active in the last 12 months only",
            "type": "boolean",
            "description": "product and location modes: skip companies with no shipment in the last 12 months. Applied before a profile is fetched, so skipped companies are never charged.",
            "default": false
          },
          "minShipments": {
            "title": "Minimum shipments",
            "minimum": 0,
            "type": "integer",
            "description": "product and location modes: skip companies with fewer shipments on the listing than this. 0 keeps all.",
            "default": 0
          },
          "country": {
            "title": "Country filter",
            "type": "string",
            "description": "product and location modes: keep only companies in this country, as a two-letter code ('CN', 'VN', 'US') or the name ImportYeti uses ('China')."
          },
          "countries": {
            "title": "Country filter (several)",
            "type": "array",
            "description": "As 'Country filter', for several countries at once.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "includeShipments": {
            "title": "Include recent bills of lading",
            "type": "boolean",
            "description": "Also return each profile's 50 most recent bills of lading as separate free rows: date, house/master BOL, carrier, the other party, weight (kg), quantity, containers, product description, lane and ImportYeti's freight-cost estimate.",
            "default": false
          },
          "enrichContacts": {
            "title": "Find contact details",
            "type": "boolean",
            "description": "Add phone numbers ImportYeti publishes for the company, plus emails, phones and social links found on the company's own website. Charged as a separate 'Contact details found' event, only for profiles where at least one email or phone was found.",
            "default": false
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Profiles per query. A tag page lists up to 20 importers + 20 suppliers, an HS-code page up to 50 + 50, a country page 50 suppliers; ImportYeti has no page 2, so asking for more returns what is listed and says so on a free row.",
            "default": 20
          },
          "company": {
            "title": "Company (legacy)",
            "type": "string",
            "description": "Older input name for a profile query, kept so saved tasks keep working. Without 'Mode', it runs in profile mode."
          },
          "companies": {
            "title": "Companies (legacy batch)",
            "type": "array",
            "description": "Older batch input for profile queries, kept so saved tasks keep working.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "ImportYeti limits each IP address to 25 pages, so the run spreads its pages over fresh Apify Proxy IPs. Leave on; the proxy costs you nothing extra.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}