# ImportYeti profile: `POST /v1/importyeti/profile`

Cost: 5 credits (5 (an unknown company and failed requests are free)). Docs: https://scrapercompany.com/docs/reference/importyeti-profile

One company's or supplier's US import history from customs bills of
lading.

Returns names it ships under, address, website, total and last-12-month
shipments, first and last shipment dates, estimated shipping spend, FCL
and LCL share, average TEU, top trading partners (its suppliers for a
company, its customers for a supplier) with shipment counts, weight and
HS codes, HS and HTS codes, port-to-port lanes, carriers, notify parties,
trademarks and the most recent shipments. Set include_time_series for
monthly totals. No contact details are returned. An unknown profile is a
404 and is not charged.

Request body (JSON):

- `url` (string | null; optional; max length 500): An ImportYeti company or supplier link, e.g. https://www.importyeti.com/company/apple (the url a search result carries). Give this or type + slug.
- `type` (string | null; optional; one of company, supplier): company (a US importer) or supplier (a foreign shipper). Needed with slug.
- `slug` (string | null; optional; max length 200): The profile's slug, as in a search result's slug field (e.g. hon-hai-precision-industrial).
- `include_time_series` (boolean; optional; default false): Also return monthly shipments, weight and TEU since the first recorded shipment.

Base URL: `https://api.scrapercompany.com`. Auth: send your key in the `x-api-key` header. A failed request (4xx or 5xx) or an empty result costs 0 credits.

- [Full API reference as one Markdown file](https://scrapercompany.com/llms-full.txt)
- [OpenAPI spec](https://scrapercompany.com/openapi.json)
