> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/english/developers/get-api-status.md).

# GET API status

Perform a free GET request to query the status of all Altum AI services.

{% hint style="info" %}
Make use of the generic and free API key provided in the GET request
{% endhint %}

## Access the status of all Altum Services with api.altum.ai/status

<mark style="color:blue;">`GET`</mark> `https://api.altum.ai/status`

#### Headers

| Name                                        | Type   | Description                              |
| ------------------------------------------- | ------ | ---------------------------------------- |
| x-api-key<mark style="color:red;">\*</mark> | String | m2ipzWVV3e9yPU9TduqpY4oZTbcEHCGj31GLVLYB |

{% tabs %}
{% tab title="200: OK OK" %}

```
{
	"altum_services": [
		{
			"service": "Altum.AI website",
			"url": "https://altum.ai",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Amenities API",
			"url": "https://api.altum.ai/amenities",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Autosuggest API",
			"url": "https://api.altum.ai/autosuggest",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "AVM API",
			"url": "https://api.altum.ai/avm",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "BAG API",
			"url": "https://api.altum.ai/bag",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Condition score API",
			"url": "https://api.altum.ai/condition-score/url",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Energy & climate API",
			"url": "https://api.altum.ai/energy-climate",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Energylabel API",
			"url": "https://api.altum.ai/energylabel",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Interactive Reference API",
			"url": "https://api.altum.ai/interactive-reference",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Labelling API",
			"url": "https://api.altum.ai/labelling/url",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Location Data API",
			"url": "https://api.altum.ai/location",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Data Platform",
			"url": "https://platform.altum.ai",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Move Data API",
			"url": "https://api.altum.ai/movedata/sale",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Object geometry API",
			"url": "https://api.altum.ai/geometry",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Objectdata API",
			"url": "https://api.altum.ai/objectdata",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Sustainability API",
			"url": "https://api.altum.ai/sustainability",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "Transaction API",
			"url": "https://api.altum.ai/transaction",
			"timeout": 30,
			"status": "UP"
		},
		{
			"service": "WOZ API",
			"url": "https://api.altum.ai/woz",
			"timeout": 30,
			"status": "UP"
		}
	]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.altum.ai/english/developers/get-api-status.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.