---
title: "Flatmates API: Listing | Perceptlayer"
description: "Listing from Flatmates as JSON. 1 credit per successful call."
url: https://perceptlayer.com/apis/flatmates/listing
---

[APIs](https://perceptlayer.com/apis) / [Flatmates](https://perceptlayer.com/apis/flatmates) / Listing

# Flatmates: Listing

Listing from Flatmates as JSON. 1 credit per successful call.

GET `/v1/flatmates/listing`

## Parameters

Send parameters in the query string.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `url` | string | Optional | Up to 300 characters |
| `id` | integer | Optional | Any |
| `slug` | string | Optional | Up to 200 characters |

## Example request

cURL shell 

```
curl "https://api.perceptlayer.com/v1/flatmates/listing?url=https%3A%2F%2Fflatmates.com.au%2Fshare-house-sydney-balgowlah-2093-P1432574" \
  -H "X-API-Key: $API_KEY"
```

[Run this endpoint in the playground](https://perceptlayer.com/apis/flatmates?try=listing#playground) with your own parameters. 1 credit per successful call; failed calls are free.