Guide

Search shipments with PowerQuery

PowerQuery is how you filter real shipment documents — not just profiles. Start by picking the dataset that matches your question.

Pick a dataset

Example: US import furniture shipments

Costs 1 data credit per 10 records returned. Dates use mm/dd/yyyy.

curl "https://data.importyeti.com/v1.0/powerquery/us-import/bols?product_description=furniture&page_size=5&start_date=01/01/2024" \
  -H "IYApiKey: YOUR_API_KEY"

Read the results

PowerQuery nests the rows one level below data, alongside the total number of matches. Reach for data.data, not data:

JSON
{
  "requestCost": 0.5,
  "creditsRemaining": 9998.5,
  "data": {
    "data": [
      {
        "bol_number": "CCLLMILS17011590",
        "arrival_date": "08/21/2017",
        "company_name": "Poliform Usa Inc",
        "supplier_name": "Poliform Spa",
        "product_description": "Kitchen Furniture Bedroom Furniture",
        "hs_code": "940340",
        "weight": 1327
      }
    ],
    "totalCount": 59583
  },
  "executionTime": "224ms"
}

totalCount is how many shipments matched in total — use it to decide whether to fetch another page. Aggregation routes name that field differently (totalCompanies, totalSuppliers, totalBrokers); see where the results actually live.

Page through everything

Raise page_size to 50 and walk offset forward until you have covered totalCount. Remember each page of 10 records costs 1 data credit.

const url = new URL("https://data.importyeti.com/v1.0/powerquery/us-import/bols");
url.searchParams.set("product_description", "furniture");
url.searchParams.set("page_size", "50");

let offset = 0;
let total = Infinity;

while (offset < total) {
  url.searchParams.set("offset", String(offset));

  const res = await fetch(url, { headers: { IYApiKey: "YOUR_API_KEY" } });
  const { data } = await res.json();

  for (const bol of data.data) {
    console.log(bol.bol_number, bol.company_name);
  }

  total = data.totalCount;
  offset += 50;
}

Sharpen the query

  • Require both terms: product_description=wooden AND furniture
  • Exact phrase: product_description="office chairs"
  • Filter by importer slug: company=ikea-supply
  • HS code with wildcard: hs_code=9401*

Full operator reference: PowerQuery syntax.

Related