{
  "openapi": "3.0.1",
  "info": {
    "title": "ImportYeti Scraper: US Importer Suppliers and Shipments",
    "description": "Get the suppliers of any US importer from ImportYeti bill of lading data: supplier name, address and country, shipments in the last 12 months and all time, first and last shipment, HS codes and products, plus company totals and top supplier countries. Names, slugs or links. No login.",
    "version": "0.1",
    "x-build-id": "0h9QSOMbVg3WyJsCb"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~importyeti-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~importyeti-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-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/themineworks~importyeti-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-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": {
          "companies": {
            "title": "Company names",
            "type": "array",
            "description": "US importers to read, one per line: a company name (apple, Wal Mart), an ImportYeti slug (wal-mart) or a company link (https://www.importyeti.com/company/wal-mart). Each gives one row per supplier. A name is matched to the importer ImportYeti files under that name with the most shipments; check companyName in the rows. Leave it empty ([]) to run only suppliers or product keywords. Left empty with nothing else filled in, the run reads \"apple\" as an example.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Max suppliers per company",
            "minimum": 10,
            "type": "integer",
            "description": "Partner rows per profile, largest first: suppliers of a company, customers of a supplier. Minimum 10. One profile charge includes the first 10 rows; each row after that is charged as an extra partner. ImportYeti's public pages list up to 50 partners, so higher values return at most 50.",
            "default": 10
          },
          "suppliers": {
            "title": "Supplier names",
            "type": "array",
            "description": "Optional. Foreign suppliers to read, one per line: a name (Hon Hai Precision Industrial), an ImportYeti slug or a supplier link (https://www.importyeti.com/supplier/hon-hai-precision-industrial). Each gives one row per US customer.",
            "items": {
              "type": "string"
            }
          },
          "productQueries": {
            "title": "Product keywords",
            "type": "array",
            "description": "Optional. Products to find importers and suppliers for, one per line (hdmi cable, bluetooth speaker, bath towels). Each keyword reads ImportYeti's product page (its top 20 US importers and top 20 suppliers of that product) and tops up from ImportYeti search. Every hit is delivered as a full profile with its partner rows.",
            "items": {
              "type": "string"
            }
          },
          "maxProfiles": {
            "title": "Max profiles per product keyword",
            "minimum": 10,
            "maximum": 500,
            "type": "integer",
            "description": "Profiles (importers or suppliers) delivered for each product keyword. Minimum 10.",
            "default": 10
          },
          "profileType": {
            "title": "Product search returns",
            "enum": [
              "both",
              "importers",
              "suppliers"
            ],
            "type": "string",
            "description": "Which profiles a product keyword returns: US importers, foreign suppliers, or both.",
            "default": "both"
          },
          "lastShipmentWithinMonths": {
            "title": "Last shipment within (months)",
            "minimum": 1,
            "maximum": 132,
            "type": "integer",
            "description": "Optional, product keywords only. Keep profiles whose latest shipment is within this many months of ImportYeti's latest data. Profiles dropped by this filter are never charged."
          },
          "minShipments": {
            "title": "Minimum total shipments",
            "minimum": 1,
            "type": "integer",
            "description": "Optional, product keywords only. Keep profiles with at least this many shipments in all. Profiles dropped by this filter are never charged."
          },
          "includeUnnamedPartners": {
            "title": "Include unnamed partners",
            "type": "boolean",
            "description": "ImportYeti groups shipments whose bill of lading names no shipper or no consignee under \"Missing in source document\". Off (default): those rows are skipped. On: they are delivered as partner rows with unnamedPartner set to true.",
            "default": false
          },
          "startUrls": {
            "title": "Profile links (optional)",
            "type": "array",
            "description": "Optional. ImportYeti company or supplier links, read together with the lists above.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}