> For the complete documentation index, see [llms.txt](https://developer.aiodds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.aiodds.com/get-started/quickstart.md).

# Quickstart

Use this quickstart to move from account access to your first AiOdds integration path.

## What you need

Before you begin, make sure you have:

| Requirement             | Notes                                                                                        |
| ----------------------- | -------------------------------------------------------------------------------------------- |
| AiOdds account          | Provided by AiOdds.                                                                          |
| Username and secret     | Required for HTTPS API and WebSocket authentication.                                         |
| Allowed IP address      | AiOdds API access may be restricted by IP allowlist.                                         |
| Product access          | Bookmaker Odds, Trading Odds, or both.                                                       |
| Integration environment | A backend service that can call HTTPS APIs and, when needed, maintain WebSocket connections. |

### Step 1: Confirm console access

Open [Customer Console](https://www.aiodds.com/monitoring).

You should be able to see modules such as Monitoring, Trading, Subscription, Tickets, API Documentation, Live Tracker, and Help Center.

### Step 2: Choose the documentation space

Use the product you purchased to choose the technical reference:

| Need                                                                                          | Go to                                                          |
| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| Sports, tournaments, locations, markets, bookmakers, markets, pre-match odds, or in-play odds | [Bookmaker Odds](https://developer.aiodds.com/bookmaker-odds/) |
| Proprietary odds, trading rules, trading feed, or trading WebSocket workflows                 | [AI Trading](https://developer.aiodds.com/trading-odds/)       |

### Step 3: Validate HTTPS API access

AiOdds HTTPS APIs are served from:

```
https://api.aiodds.com
```

All API requests use the global authentication parameters provided by AiOdds:

| Parameter | Description     |
| --------- | --------------- |
| `user`    | unique username |
| `secret`  | user secret     |

Responses are returned as JSON. 

Dates are returned as Unix timestamps.

### Step 4: Validate WebSocket access

Real-time delivery uses MQTT over WebSocket from:

```
mq.aiodds.com
```

Use MQTT v5 when possible. WebSocket access requires your username, secret, and allowed network access.

Start from one common topic:

```
match/<user>
```

### Step 5: Monitor the result

Use the Monitoring module in the customer console to compare feed behavior with live operational views.

## Verification

Your first integration path is ready when:

* You can sign in to the Customer Console.
* Your API credentials are confirmed.
* Your IP address is allowlisted where required.
* Your backend can call the HTTPS API or connect to the MQTT over WebSocket feed.

## Troubleshooting

| Issue                          | What to check                                                            |
| ------------------------------ | ------------------------------------------------------------------------ |
| Invalid IP address             | Confirm your server IP is allowlisted by AiOdds.                         |
| Illegal request                | Confirm endpoint, method, required parameters, and product permission.   |
| Request parameter format error | Check parameter names, value formats, and required fields.               |
| WebSocket does not connect     | Confirm username, secret, domain, TLS, WebSocket path, and IP allowlist. |

### Summary

You are ready to proceed once access, credentials, IP allowlisting, and the product path are confirmed.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.aiodds.com/get-started/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.