Skip to main content
POST
/
api
/
suumo
/
companies
/suumo/companies
curl --request POST \
  --url https://api.anysite.io/api/suumo/companies \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "company": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@suumo_company",
    "name": "<string>",
    "tel": "<string>",
    "fax": "<string>",
    "address": "<string>",
    "stations": [],
    "business_hours": "<string>",
    "holidays": "<string>",
    "license_number": "<string>",
    "features": [],
    "related_site": "<string>",
    "catch_copy": "<string>",
    "sales_points": [],
    "staff": [],
    "image": "<string>",
    "images": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
company
string
required

SUUMO rental agency shop as kc_{ar}_{id} or a full shop URL

Minimum string length: 1
Examples:

"kc_030_107039021"

"https://suumo.jp/chintai/kaisha/kc_030_107039021/"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
id
string
required
​
url
string
required
​
@type
string
default:@suumo_company
​
name
string | null
​
tel
string | null
​
fax
string | null
​
address
string | null
​
stations
SuumoStation · object[]
​
business_hours
string | null
​
holidays
string | null
​
license_number
string | null
​
features
string[]
​
related_site
string | null
​
catch_copy
string | null
​
sales_points
SuumoCompanySalesPoint · object[]
​
staff
SuumoCompanyStaff · object[]
​
image
string | null
​
images
string[]