> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3iq.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List the hosted gateway endpoints.

Index of the public hosted gateway surface, returned so a client that lands on the base URL learns what is served here without guessing. The machine-readable form of the same information is this document; the response advertises it with `Link: <https://b3iq.org/openapi.json>; rel="service-desc"` (RFC 8631). 

` GET /v1/api `

List the hosted gateway endpoints.

Index of the public hosted gateway surface, returned so a client that
lands on the base URL learns what is served here without guessing. The
machine-readable form of the same information is this document; the
response advertises it with `Link: <https://b3iq.org/openapi.json>;
rel="service-desc"` (RFC 8631).


## Servers

- ` https://b3iq.org ` — Public hosted gateway facade.

## Responses

### ` 200 ` — Endpoint index.

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` name `, ` base_url `, ` endpoints `

  - ` name `: type ` string `

  - ` base_url `: type ` string `; format ` uri `

  - ` endpoints `: type ` array ` — Method + path, relative to `base_url`.

    - ` array item `: type ` string `

  - ` openapi_url `: type ` string `; format ` uri ` — This document.

  - ` documentation_url `: type ` string `; format ` uri `

### ` default ` — B3IQ-native problem response.

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` object `

    - Required fields: ` status `, ` title `, ` detail `

    - ` status `: type ` integer `

    - ` title `: type ` string `

    - ` detail `: type ` string `

    - ` code `: type ` string ` — Stable B3IQ code when present. See docs/error-codes.md.

## Request examples

### cURL

```curl
curl -X GET 'https://b3iq.org/v1/api'
```

### JavaScript

```javascript
const response = await fetch('https://b3iq.org/v1/api', {
  method: 'GET'
});

const data = await response.json();
console.log(data);
```