Quickstart

This walks you through making your first call against the YourNextHome API. You'll mint a key, list your estates, and fetch one estate's details.

1. Get an API key

Follow Authentication to mint an organization API key. For the rest of this page we'll assume your key is in an environment variable:

export YNH_API_KEY="ynh_live_xxxxxxxxxxxxxxxxxxxx"

2. List your estates

curl https://api.yournexthome.app/api/v1/estates \
  -H "Authorization: Bearer $YNH_API_KEY"

A successful response looks like:

{
  "data": [
    {
      "id": "0c3b8f9e-...",
      "name": "Maple Heights",
      "subscriptionStatus": "ACTIVE"
    }
  ],
  "total": 1
}

3. Fetch one estate

Grab an id from the previous response and call:

curl https://api.yournexthome.app/api/v1/estates/$ESTATE_ID \
  -H "Authorization: Bearer $YNH_API_KEY"

That's it. Browse the full API Reference for every other resource — apartments, buildings, navigators, inquiries, and more.

What's next

• Read about error responses so you know what to retry and what to fix.
• Review rate limits before you build anything high-throughput.