# /importyeti/addresses/search

`POST /api/importyeti/addresses/search`

Price: 5 credits

Find businesses in US ocean import records whose filed address matches the given text, rather than their name. Narrowable by side of the trade, shipment recency and a minimum shipment count.

## How to use it

Reach for this when the question is about a place rather than a name: everyone shipping to one warehouse, one industrial park or one postcode. Matching is loose text over the address as filed with customs, so a bare city or postcode matches far more businesses than a single call returns - narrow to a street line or apply the filters instead of treating the result as the complete set of matches for that place. Ids come back in the qualified form /importyeti/companies takes.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, required) — Address text to match, for example a street, a city or a postcode (examples: "13630 sw terman rd", "beaverton, or 97005", "sudetenstrasse freilassing"; minLength: 1)
- `count` (integer, required) — Max number of results (min: 1; max: 500)
- `profile_type` (string) — Restrict to US importers (company), to their foreign counterparties (supplier), or return both sides (default: "both"; one of: "both", "company", "supplier")
- `most_recent_shipment` (string) — Keep only businesses whose latest recorded shipment falls inside this window (default: "any"; one of: "any", "6mo", "12mo")
- `min_shipments` (integer, nullable) — Keep only businesses with strictly more recorded shipments than this (min: 0)

## Response

### 200 — Successful Response

- `@type` (string) (default: "ImportyetiProfile")
- `id` (string, required)
- `alias` (string, required)
- `role` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `country_code` (string, nullable)
- `address` (string, nullable)
- `total_shipments` (integer, nullable)
- `last_shipment_date` (string, nullable)
- `other_addresses_count` (integer, nullable)
- `other_names_count` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.