ImportYeti

Getting started

Build with the ImportYeti API to access US and Mexico import shipment data directly in your applications. The API is designed to be fast, reliable, and easy to integrate, giving you structured access to shipment records, companies, and trade flows. Use this documentation to authenticate, explore endpoints, and make your first request.

The same API also covers US export and Mexico export.

Data credits are used to access data through the API. Each endpoint specifies its credit cost. Successful responses include:

  • requestCost — credits used for the request
  • creditsRemaining — remaining balance after the request

What you can look up

Bill of Lading (BOL)

A document used to track and verify a shipment, containing information such as the carrier, shipper, consignee, cargo details, and transportation route.

1) I have a Bill of Lading number
→ Retrieve the BOL with GET /v1.0/bol/{number}

2) View shipment details

  • Shipper
  • Consignee
  • Ports
  • Product Description
  • Cargo, etc.

Company

A US-based business involved in shipments as a buyer, shipper, consignee, or carrier. Search companies by name, retrieve company details by ID, and access related Bills of Lading (BOLs).

1) I want to research Walmart
→ Search Company by name or ID with GET /v1.0/company/search

2) Retrieve company details

  • Company information
  • Total shipments, etc.
  • Suppliers they work with

Then open the profile, for example GET /v1.0/company/wal-mart.

Supplier

A supplier is a company outside the United States that provides products to US businesses. Supplier records include company details and related Bills of Lading (BOLs).

1) I want to research Foxconn
→ Search Supplier by name or ID with GET /v1.0/supplier/search

2) Retrieve supplier details

  • Product Description
  • Total shipments
  • US companies they supply
  • Cargo, etc.

Product

A product represents goods imported into the United States. Product records can help you identify the suppliers that provide the product and the US companies that purchase it.

1) I want to research Bluetooth speakers
→ Search Product by name with rank buyers & suppliers by product

2) Discover companies trading this product

  • Overseas suppliers
  • US buyers

PowerQuery

PowerQuery provides advanced search across US import/export Bills of Lading and Mexico import/export customs declarations. Search shipments, companies, suppliers, brokers, and customs records using flexible filters to discover trade relationships, shipment activity, and import/export trends.

How to research US imports

1) I want to find all shipments imported by Walmart
→ Search US Import Companies with GET /v1.0/powerquery/us-import/companies

2) Explore import activity

  • Related Bills of Lading
  • Overseas suppliers
  • Shipment history

How to research US exports

1) I want to research a US exporter
→ Search US Export Companies with GET /v1.0/powerquery/us-export/companies

2) Explore export activity

  • Export Bills of Lading
  • Shipment history
  • Trading partners

See also search shipments with PowerQuery and PowerQuery syntax.

Database

Returns the last-updated date for ImportYeti’s trade database. This call is free. See GET /v1.0/database-updated.

1. Get an API key

What is an API Key?

An API key is a unique identifier used to authenticate and authorize requests made to the API. It allows the system to recognize your account and verify that you have permission to access API services.

Your API key works like a password for your API access. It should be kept private and secure and should not be shared publicly or exposed in client-side code, public repositories, or with unauthorized users.

When making API requests, your API key is included with the request to confirm your identity and track your API usage, such as the number of requests made and available API credits.

If your API key is compromised, contact support or generate a new key to prevent unauthorized usage.

Getting your API Key

Create an account and register your email address. Once logged in, go to My Account → Settings → API Credits Settings. There you will find your API key, along with your remaining API credit balance.

2. Base URL

Base URL
https://data.importyeti.com

All REST routes are versioned, for example /v1.0/company/ikea-supply.

3. Make your first call

Fetch a US company profile by its ImportYeti URL slug. This costs 1 data credit.

curl "https://data.importyeti.com/v1.0/company/ikea-supply" \
  -H "IYApiKey: YOUR_API_KEY" \
  -H "Accept: application/json"

4. Read the response envelope

Successful paid calls typically look like:

JSON
{
  "requestCost": 1,
  "creditsRemaining": 9999,
  "data": { /* endpoint payload */ },
  "executionTime": "591ms"
}
  • requestCost — credits used for the request
  • creditsRemaining — remaining balance after the request
  • data — the actual result

Next steps