Class: Housing
# Class: Housing
# Example
const active = await client.housing.active();
1
# Extends
Method
# API
# houses
houses:
HousingHouses
Returns public houses for a specific player.
# Example
const houses = await client.housing.houses.player('20934ef9488c465180a78f861586b4cf');
1
# active()
active():
Promise<FlatResultArray<$200>>
The currently active public houses.
# Returns
Promise<FlatResultArray<$200>>
# Example
const activeHousing = await client.housing.active();
1
# house()
house(
house):Promise<ResultObject<HousingHouseResponse, [],true>>
Returns information about a specific house.
# Parameters
• house: string
# Returns
Promise<ResultObject<HousingHouseResponse, [], true>>
# Example
const houseData = await client.housing.house('20934ef9488c465180a78f861586b4cf');
1