# /tdb/companies/search

`POST /api/tdb/companies/search`

Price: 5 credits

Search the Teikoku Databank company directory (TDB企業サーチ) by company name, head-office address, profile keyword, TDB company code or corporate number: TDB company code, name, address, industry and the TDB company reports on sale with their fiscal period

## How to use it

At most 100 companies per query; add address or exact_name to narrow a common name. tdb_code matches the code on tdb/bankruptcies reports.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `count` (integer, required) — Max number of results (min: 1; max: 100)
- `name` (string, nullable) — Company name (examples: "トヨタ"; minLength: 1)
- `exact_name` (boolean) — Match the company name exactly instead of by its start (default: false)
- `address` (string, nullable) — Prefecture and city of the head office (examples: "愛知県豊田市"; minLength: 1)
- `keyword` (string, nullable) — Words in the company's own profile text (examples: "自動車"; minLength: 1)
- `public_profile_only` (boolean) — Only companies that publish a profile on TDB (default: false)
- `tdb_code` (string, nullable) — TDB company code (examples: "983971617"; pattern: ^\d{9}$)
- `corporate_number` (string, nullable) — Japanese corporate number (examples: "6020001071355"; pattern: ^\d{13}$)

## Response

### 200 — Successful Response

- `@type` (string) (default: "TdbCompany")
- `tdb_code` (string, required)
- `name` (string, required)
- `address` (string, nullable)
- `industry` (string, nullable)
- `products` (array) (default: [])
  - `@type` (string) (default: "TdbCompanyProduct")
  - `name` (string, required)
  - `period` (string, nullable)
  - `url` (string, 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.