Skip to main content
POST
/
api
/
suumo
/
companies
/
search
/suumo/companies/search
curl --request POST \
  --url https://api.anysite.io/api/suumo/companies/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "station": "<string>",
  "count": 2,
  "timeout": 300,
  "line": "<string>",
  "access": [],
  "staff_features": [],
  "services": [],
  "media": [],
  "keyword": "<string>"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@suumo_company_card",
    "name": "<string>",
    "headline": "<string>",
    "listing_count": 123,
    "address": "<string>",
    "station": "<string>",
    "walk": "<string>",
    "business_hours": "<string>",
    "holidays": "<string>",
    "tel": "<string>",
    "features": [],
    "image": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
pref
enum<string>
required

Prefecture the station belongs to

Available options:
tokyo,
kanagawa,
osaka,
saitama,
chiba,
aichi,
hyogo,
fukuoka,
hokkaido,
kyoto
​
station
string
required

Station the agencies are searched around — a station name (e.g. '新宿', '渋谷'; provide line to disambiguate) or a 9-digit SUUMO station code (e.g. '000517640')

Minimum string length: 1
Examples:

"新宿"

"000517640"

"015519133"

​
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
​
line
string | null

Railway line the station belongs to (e.g. 'JR山手線'); used to resolve a station name to its code. Not needed when station is already a 9-digit code

Minimum string length: 1
​
access
enum<string>[] | null

Access/opening-hours features the agency must have (all of)

Available options:
open_late,
near_station,
open_year_round,
parking,
car_pickup
​
staff_features
enum<string>[] | null

Staff features the agency must have (all of)

Available options:
foreign_language,
female_staff,
consulting_master
​
services
enum<string>[] | null

Services/amenities the agency must offer (all of)

Available options:
local_10_years,
multi_store,
kids_service,
barrier_free,
rent_guarantor,
no_guarantor_ok,
move_in_loan,
mover_referral,
management_24h,
handles_sales,
corporate_contracts,
company_housing
​
media
enum<string>[] | null

SUUMO media the agency must publish — video, coupon, staff comment (all of)

Available options:
has_video,
has_coupon,
has_staff_comment
​
keyword
string | null

Free-text keyword to match against the agency listing

​
sort
enum<string> | null

Sort order

Available options:
name_asc,
name_desc,
listings_desc,
listings_asc

Response

Successful Response

​
id
string
required
​
url
string
required
​
@type
string
default:@suumo_company_card
​
name
string | null
​
headline
string | null
​
listing_count
integer | null
​
address
string | null
​
station
string | null
​
walk
string | null
​
business_hours
string | null
​
holidays
string | null
​
tel
string | null
​
features
string[]
​
image
string | null