> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Player homes
> Fetches the player homes on the Lagos Life map: each player's id and username, verified flag, home type with its name, area, city and weekly in-game rent, the number of items in the home, and whether the player is online and at home. Takes no parameters. Only publicly available data is returned.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/lagos-life/homes. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/lagos-life/homes
Description: Fetches the player homes on the Lagos Life map: each player's id and username, verified flag, home type with its name, area, city and weekly in-game rent, the number of items in the home, and whether the player is online and at home. Takes no parameters. Only publicly available data is returned.
Required Headers:
- x-api-key: Your API key
Parameters:
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"homes": [
{
"userId": "10a1bd2aa50d4155a18a",
"username": "shallyr",
"isVerified": true,
"homeType": "bananaIsland",
"homeName": "Mansion",
"area": "Banana Island",
"city": "lagos",
"rent": 1500000,
"items": 44,
"online": false,
"atHome": false
}
],
"count": 400,
"fetchedAt": "2026-10-09T16:37:09.572Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/lagos-life/homes
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
- name: Instagram
description: Instagram scraping endpoints
- name: Lagos Life
description: Lagos Life scraping endpoints
paths:
/v1/lagos-life/homes:
get:
tags:
- Lagos Life
summary: Player homes
description: >-
Fetches the player homes on the Lagos Life map: each player's id and
username, verified flag, home type with its name, area, city and weekly
in-game rent, the number of items in the home, and whether the player is
online and at home. Takes no parameters. Only publicly available data is
returned.
parameters:
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The homes on the map.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
homes:
type: array
items:
type: object
count:
type: integer
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
homes:
- userId: 10a1bd2aa50d4155a18a
username: shallyr
isVerified: true
homeType: bananaIsland
homeName: Mansion
area: Banana Island
city: lagos
rent: 1500000
items: 44
online: false
atHome: false
- userId: 015f1effa32d4f09a197
username: owee
isVerified: false
homeType: mushin
homeName: Face-me-I-face-you
area: Mushin
city: lagos
rent: 2400
items: 9
online: false
atHome: false
- userId: f9a0a3b77b9043828b8f
username: adam
isVerified: false
homeType: yaba
homeName: Self-contain
area: Yaba
city: lagos
rent: 6000
items: 10
online: false
atHome: false
count: 400
fetchedAt: '2026-10-09T16:37:09.572Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.