Skip to main content
POST
/
api
/
lifull
/
companies
/lifull/companies
curl --request POST \
  --url https://api.anysite.io/api/lifull/companies \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "company": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@lifull_company",
    "name": "<string>",
    "name_kana": "<string>",
    "homepage_url": "<string>",
    "address": "<string>",
    "transit": [],
    "business_hours": "<string>",
    "holidays": "<string>",
    "tel": "<string>",
    "fax": "<string>",
    "license_number": "<string>",
    "associations": [],
    "guarantee_associations": [],
    "rent_deals": "<string>",
    "sale_deals": "<string>",
    "features": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
company
string
required

LIFULL HOME'S real-estate company id (mid-...) or a full /realtor/mid-{id}/ URL

Minimum string length: 1
Examples:

"https://www.homes.co.jp/realtor/mid-109083hNUl2kTJ4S74/"

"109083hNUl2kTJ4S74"

​
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:@lifull_company
​
name
string | null
​
name_kana
string | null
​
homepage_url
string | null
​
address
string | null
​
transit
string[]
​
business_hours
string | null
​
holidays
string | null
​
tel
string | null
​
fax
string | null
​
license_number
string | null
​
associations
string[]
​
guarantee_associations
string[]
​
rent_deals
string | null
​
sale_deals
string | null
​
features
string[]