Companies
GET

Get a US company profile by slug

1 per record

Return the full ImportYeti profile for a US company using its URL slug (e.g. ikea-supply), not the legal name. Resolve names via company search first.

Parameters#

Path parameters

  • companystringrequired

    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 response fields to keep on each returned record. Every other field on the record is omitted. Names the record does not have are ignored. The envelope (requestCost, creditsRemaining, executionTime, totalCount) is always returned in full. Cannot be combined with exclude. Leave this out for the full record.

  • excludestringoptional

    Comma-separated list of response fields to drop from each returned record. Every other field is kept. Cannot be combined with fields. Leave this out 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.

Response#

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"
}

Top-level fields#

  • data — the result object for this endpoint
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took

Fields in data#

FieldExample
30 fields
  • titlestringWalmart
  • also_known_namesstring[]["Walmart Inc", "Walmart Usa"]
  • addressstring601 N Walton Blvd, Bentonville, Ar 72712, Us
  • address_plainstring601 N Walton Blvd Bentonville Ar 72716-0410 Usa
  • address, most_recent_shipment_to, contact_info_data

  • websitestringwalmart.com
  • [{"website": "ups.com", "frequency": 6}]

    website, frequency

  • phone_numberstring+18009256278
  • total_shipmentsnumber436207

    The company's total shipments on record, independent of the filters in this query.

  • countrystringUnited States
  • country_codestringUS
  • carriers_per_countryobject

Errors#

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.