Quickstart: first Immoteur API request

Use this guide to verify that your token works and to see the data access available to your integration.

Create an API token

In the Immoteur dashboard, open Settings → API tokens and create a token. Keep it outside your source code. See API tokens and data access for the dashboard steps.

Store the token locally

Set IMMOTEUR_TOKEN in your shell or secret store before making requests.

export IMMOTEUR_TOKEN='YOUR_TOKEN'

Call the authentication endpoint

Send GET /auth with the Bearer token. The following requests are equivalent.

curl --fail-with-body --show-error --silent \
  'https://api.immoteur.com/public/v1/auth' \
  -H "Authorization: Bearer $IMMOTEUR_TOKEN"

const response = await fetch('https://api.immoteur.com/public/v1/auth', {
  headers: { Authorization: `Bearer ${process.env.IMMOTEUR_TOKEN}` },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const account = await response.json();

import os
import requests

response = requests.get(
    "https://api.immoteur.com/public/v1/auth",
    headers={"Authorization": f"Bearer {os.environ['IMMOTEUR_TOKEN']}"},
    timeout=10,
)
response.raise_for_status()
account = response.json()

Confirm the result and choose the next task

A successful response is 200 OK and includes token metadata plus meta.dataAccessLimit. Next, choose an API resource to retrieve data or configure webhooks to receive updates.

If the request does not return 200, see API reliability before changing your integration.

Overview Tokens & access

Start

API

Webhooks

OpenAPI reference

Quickstart: first Immoteur API request