{
  "openapi": "3.0.1",
  "info": {
    "title": "US Import Data API - ImportYeti Bill of Lading and Suppliers",
    "description": "US customs import data from the ImportYeti API: search bills of lading with PowerQuery, rank top US importers and overseas suppliers, pull company and supplier profiles, BOL lists and lookups, and find suppliers or buyers by product, HS code, port and country. Bring your own key.",
    "version": "0.1",
    "x-build-id": "c62KixuBA2kcltxGL"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nabeelbaghoor~us-import-bill-of-lading-data-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nabeelbaghoor-us-import-bill-of-lading-data-api",
        "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/nabeelbaghoor~us-import-bill-of-lading-data-api/runs": {
      "post": {
        "operationId": "runs-sync-nabeelbaghoor-us-import-bill-of-lading-data-api",
        "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/nabeelbaghoor~us-import-bill-of-lading-data-api/run-sync": {
      "post": {
        "operationId": "run-sync-nabeelbaghoor-us-import-bill-of-lading-data-api",
        "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": "What to run",
            "enum": [
              "shipmentSearch",
              "topImporters",
              "topSuppliers",
              "companySearch",
              "supplierSearch",
              "companyProfile",
              "supplierProfile",
              "companyBols",
              "supplierBols",
              "bolLookup",
              "productSuppliers",
              "productCompanies"
            ],
            "type": "string",
            "description": "PowerQuery shipment search returns US import bills of lading that match your filters. Top US importers and Top overseas suppliers rank companies by shipment volume under the same filters. Search modes find a company or supplier and return its slug. Profile modes return the full ImportYeti profile for each slug. BOL list modes list the bills of lading of a company or supplier. Bill of lading lookup opens BOLs by number. Product modes rank suppliers or US buyers by how specialised they are in a product.",
            "default": "shipmentSearch"
          },
          "productDescription": {
            "title": "Product description",
            "type": "string",
            "description": "PowerQuery modes. Words in the cleaned product description. Supports AND, OR, NOT, parentheses, \"exact phrases\" and wildcards (at most one * and three ?), such as (sofa OR couch) AND NOT leather. Separate words without an operator are OR."
          },
          "productDescriptionRaw": {
            "title": "Raw product description",
            "type": "string",
            "description": "PowerQuery modes. Searches the original shipment wording, which keeps punctuation, codes and container text. Same operators as the product description."
          },
          "hsCode": {
            "title": "HS code",
            "type": "string",
            "description": "PowerQuery modes. HS code filter with operators and wildcards, such as 9403* or 7013* AND NOT (701391 OR 701341)."
          },
          "pqCompany": {
            "title": "US company (slug)",
            "type": "string",
            "description": "PowerQuery modes. Limit to one US importer by its ImportYeti slug, such as ikea-supply. The company search mode returns slugs."
          },
          "pqSupplier": {
            "title": "Overseas supplier (slug)",
            "type": "string",
            "description": "PowerQuery modes. Limit to one overseas supplier by its ImportYeti slug, such as poliform."
          },
          "supplierCountry": {
            "title": "Supplier country",
            "type": "string",
            "description": "PowerQuery modes. Supplier country name as ImportYeti stores it, such as China or (Vietnam OR Cambodia). The value list countries on importyeti.com shows the exact names."
          },
          "entryPort": {
            "title": "US port of entry",
            "type": "string",
            "description": "PowerQuery modes. US port of entry, such as Newark, Nj or Los Angeles*. Operators and wildcards work."
          },
          "exitPort": {
            "title": "Foreign port of lading",
            "type": "string",
            "description": "PowerQuery modes. The foreign port the shipment left from, such as Genova or Yantian. Operators and wildcards work."
          },
          "lastVisitedForeignPort": {
            "title": "Last visited foreign port",
            "type": "string",
            "description": "PowerQuery modes. The last foreign port the vessel called at before the US. Operators and wildcards work."
          },
          "notifyParty": {
            "title": "Notify party",
            "type": "string",
            "description": "PowerQuery modes. Notify party name on the bill of lading, often the customs broker or forwarder. Operators and wildcards work."
          },
          "vesselName": {
            "title": "Vessel name",
            "type": "string",
            "description": "PowerQuery modes. Vessel name, such as Seaspan Chiba. Operators and wildcards work."
          },
          "carrierScacCode": {
            "title": "Carrier (SCAC)",
            "type": "string",
            "description": "PowerQuery modes. Ocean carrier as ImportYeti names it, such as Oney or MAEU."
          },
          "containerId": {
            "title": "Container ID",
            "type": "string",
            "description": "PowerQuery modes. Container number, such as GCXU6148826. Operators and wildcards work."
          },
          "bolType": {
            "title": "BOL type",
            "enum": [
              "",
              "R",
              "H"
            ],
            "type": "string",
            "description": "PowerQuery modes. Regular carrier bills, house bills filed by a forwarder, or both.",
            "default": ""
          },
          "weight": {
            "title": "Weight range (kg)",
            "type": "string",
            "description": "PowerQuery modes. Shipment weight range, such as [1000 TO 15000] or [20000 TO *]."
          },
          "teu": {
            "title": "TEU range",
            "type": "string",
            "description": "PowerQuery modes. Twenty foot equivalent units per shipment, such as [1 TO 4]."
          },
          "companyTotalShipments": {
            "title": "Company total shipments range",
            "type": "string",
            "description": "PowerQuery modes. Lifetime shipment count of the US importer, such as [10 TO 500] to find small and mid sized buyers."
          },
          "supplierTotalShipments": {
            "title": "Supplier total shipments range",
            "type": "string",
            "description": "PowerQuery modes. Lifetime shipment count of the supplier, such as [* TO 500]."
          },
          "companyPhone": {
            "title": "Company phone",
            "type": "string",
            "description": "PowerQuery modes. US importer phone number. Wildcards work, such as 1212*."
          },
          "companyEmail": {
            "title": "Company email",
            "type": "string",
            "description": "PowerQuery modes. US importer email. Wildcards work, such as *@example.com."
          },
          "internalSupplier": {
            "title": "Internal supplier",
            "enum": [
              "",
              "true",
              "false"
            ],
            "type": "string",
            "description": "PowerQuery modes. Whether the supplier is part of the same group as the importer.",
            "default": ""
          },
          "includeOmittedData": {
            "title": "Include records with no consignee or shipper",
            "type": "boolean",
            "description": "PowerQuery modes. Also return shipments whose consignee or shipper was left empty or kept confidential on the manifest.",
            "default": false
          },
          "sortBy": {
            "title": "Rank by",
            "enum": [
              "",
              "weight"
            ],
            "type": "string",
            "description": "Top US importers and Top overseas suppliers. How the ranked list is ordered, descending.",
            "default": ""
          },
          "startDate": {
            "title": "Start date",
            "type": "string",
            "description": "PowerQuery and BOL list modes. Earliest arrival date, as YYYY-MM-DD or mm/dd/yyyy. Leave empty for ImportYeti's default of 01/01/2021."
          },
          "endDate": {
            "title": "End date",
            "type": "string",
            "description": "PowerQuery and BOL list modes. Latest arrival date, as YYYY-MM-DD or mm/dd/yyyy. Leave empty for ImportYeti's default, the last day of the previous month."
          },
          "searchName": {
            "title": "Company or supplier name",
            "type": "string",
            "description": "Search modes. Name to look for, such as Walmart or Foxconn. Give a name, a phone number or a website."
          },
          "searchPhone": {
            "title": "Phone number",
            "type": "string",
            "description": "Search modes. Phone number to look for."
          },
          "searchWebsite": {
            "title": "Website",
            "type": "string",
            "description": "Search modes. Website to look for, such as walmart.com."
          },
          "slugs": {
            "title": "Slugs",
            "type": "array",
            "description": "Profile and BOL list modes. One ImportYeti slug per line, up to 500 a run, such as walmart or ikea-supply. A search key (company/walmart) or an importyeti.com company or supplier URL also works.",
            "items": {
              "type": "string"
            }
          },
          "fetchFullBols": {
            "title": "Open each bill of lading",
            "type": "boolean",
            "description": "BOL list modes. Off returns BOL numbers only. On opens each listed BOL (one more request and 0.1 ImportYeti credit each) and returns the shipper, consignee, ports, product, HS code, weight, vessel and containers.",
            "default": false
          },
          "bolNumbers": {
            "title": "BOL numbers",
            "type": "array",
            "description": "Bill of lading lookup. One US import bill of lading number per line, up to 1,000 a run.",
            "items": {
              "type": "string"
            }
          },
          "product": {
            "title": "Product keyword",
            "type": "string",
            "description": "Product modes. Product keyword, such as furniture or bluetooth speaker. Suppliers and US buyers are ranked by how specialised they are in it."
          },
          "countries": {
            "title": "Supplier countries",
            "type": "array",
            "description": "Product modes. Only suppliers from these countries, one country name per line, such as china, india or brazil.",
            "items": {
              "type": "string"
            }
          },
          "excludeCountries": {
            "title": "Exclude supplier countries",
            "type": "array",
            "description": "Product modes. Leave out suppliers from these countries, one country name per line.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Maximum rows",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many rows. Each page of up to 50 records and each profile or BOL spends ImportYeti data credits, so start small.",
            "default": 20
          },
          "requestsPerMinute": {
            "title": "Requests per minute",
            "minimum": 1,
            "maximum": 120,
            "type": "integer",
            "description": "Optional pacing ceiling. ImportYeti publishes no fixed rate limit but throttles sustained heavy use.",
            "default": 30
          },
          "apiKey": {
            "title": "API key",
            "type": "string",
            "description": "Your ImportYeti API key, from My Account, Settings, API Credits Settings on importyeti.com. Sent only in the IYApiKey header. Falls back to the DATA_API_KEY environment variable."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}