Skip to main content
POST
/
api
/
houjinbangou
/
companies
/
search
/houjinbangou/companies/search
curl --request POST \
  --url https://api.anysite.io/api/houjinbangou/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300,
  "mode": "partial"
}
'
[
  {
    "corporate_number": "<string>",
    "name": "<string>",
    "@type": "@houjinbangou_company_search_item",
    "kana": "<string>",
    "address": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Company name to search for

Minimum string length: 1
Examples:

"トヨタ"

"三菱"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
mode
enum<string>
default:partial

Match the name as a partial substring or only as a prefix

Available options:
partial,
prefix

Response

Successful Response

​
corporate_number
string
required
​
name
string
required
​
@type
string
default:@houjinbangou_company_search_item
​
kana
string | null
​
address
string | null