ImportYeti company URL slug — the hyphenated segment from the website path /company/... (e.g. ikea-supply), not the company display or legal name. To resolve a name to a slug, use GET /company/search. Slugs use lowercase letters, digits, and hyphens; letter casing in this parameter is normalized. Underscores are accepted in place of hyphens.
Query parameters
fieldsstringoptional
Comma-separated list of fields to keep on each returned record, e.g. bol_number,arrival_date,supplier_name. Everything else is omitted. Names that the record does not carry are ignored. The envelope (requestCost, creditsRemaining, executionTime, totalCount) is always returned in full. Cannot be combined with exclude. Omit for the full record.
excludestringoptional
Comma-separated list of fields to drop from each returned record, e.g. containers,shipping_rate. Every other field is kept. Cannot be combined with fields. Omit for the full record.
formatstringoptionaldefault json
Response encoding. Defaults to json. Pass toon to receive TOON — the same data in a compact, token-efficient text form intended for LLM prompts. Error responses are always JSON.
one ofjsontoon
fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.
The full US company profile — names, shipment volume, contacts, HS codes, and trading partners.
Response shape
{"requestCost":1,"creditsRemaining":9998.5,"data":{"title":"Walmart","also_known_names":["Walmart Inc","Walmart Usa"],"address":"601 N Walton Blvd, Bentonville, Ar 72712, Us","address_plain":"601 N Walton Blvd Bentonville Ar 72716-0410 Usa","website":"walmart.com","other_websites":[{"website":"ups.com","frequency":6}],"phone_number":"+18009256278","total_shipments":436207// …22 more fields},"executionTime":"224ms"}
Failures come back as JSON with a statusCode and message. The ones worth handling here are 401 (bad or missing key), 403 (out of credits), and 404 (no such record). See all error responses.