# API Endpoints
{% hint style="danger" %}
All requests must contain a valid authentication key in the headers.
***X-RapidAPI-Key***
{% endhint %}
## Predictions
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/predictions`
This endpoint returns a list of the football predictions scheduled to start in the next 48 hours. \
The default argument for market is "classic", which shows 1X2 predictions. \
Optional parameters can be specified to show past predictions (by providing `iso_date` in the past) or to filter by federation.
#### Query Parameters
| Name | Type | Description |
| ---------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| iso\_date | string | Date in YYYY-MM-DD format
Day starts at 00:00 London Timezone
If not provided returns next predictions for matches about to start in (12h/36h/48h - based on subscription type)
|
| market | string | Check the table below for the accepted values and how it affects the response. |
| federation | string | Football association, for accepted values check the **/api/v2/list-federations** |
#### Headers
| Name | Type | Description |
| -------------- | ------ | -------------------------------------- |
| X-RapidAPI-Key | string | Provide this header for authentication |
{% tabs %}
{% tab title="200 Success." %}
```javascript
{
"data": [
{
"id": 40838,
"start_date": "2018-12-06T19:00:00",
"season": "2018 - 2019",
"status": "pending",
"home_team": "Feyenoord",
"prediction": "1",
"probabilities": {
"X2": 0.458,
"2": 0.163,
"1X": 0.837,
"1": 0.542,
"12": 0.704,
"X": 0.296
},
"is_expired": false,
"distance_between_teams": 131,
"away_strength": 0.524973751312434,
"federation": "UEFA",
"market": "classic",
"odds": {
"X2": 4.03,
"2": 12.205,
"1X": 1.04,
"1": 1.217,
"12": 1.1,
"X": 6.168
},
"competition_name": "Eredivisie",
"field_length": 105,
"stadium_capacity": 51117,
"last_update_at": "2018-12-04T20:11:57.506000",
"home_strength": 2.31326526289031,
"field_width": 68,
"away_team": "VVV-Venlo",
"result": "",
"competition_cluster": "Netherlands"
},
...
}
```
{% endtab %}
{% tab title="404 When an invalid request is made the response will return an errors field with the query parameter that causes the error and the message.
" %}
```javascript
{
"data": [],
"errors": {
"iso_date": "Date is 76 hours away. Your subscription allows seeing predictions up to 48 hours ahead."
}
}
```
{% endtab %}
{% endtabs %}
| Market | Description | Default |
| ---------------- | ----------------------------------------------------------------------------------- | ------- |
| *classic* | Predictions for final match result (1 - home victory / X - draw / 2 - away victory) | Yes |
| *over\_25* | Predicts whether there will be more than 2.5 goals scored (yes / no) | No |
| *over\_35* | Predicts whether there will be more than 3.5 goals scored (yes / no) | No |
| *btts* | Predicts whether both teams will score ( yes / no ) | No |
| *home\_over\_05* | Predicts whether the home team will score more than 0.5 goals (yes / no) | No |
| *home\_over\_15* | Predicts whether the home team will score more than 1.5 goals (yes / no) | No |
| *away\_over\_05* | Predicts whether the away team will score more than 0.5 goals (yes / no) | No |
| *away\_over\_15* | Predicts whether the away team will score more than 1.5 goals (yes / no) | No |
## Prediction Details
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/predictions/:id`
Given a match`id` will grab all the predictions (all markets) for that single event.\
Useful when you want to see all predictions for a single game.\
Matches will have at least 1 prediction in the classic market and up to 8.\
Recommendation: use the prediction endpoint with the classic market to get a list of ids.
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | number | Fixture ID |
#### Headers
| Name | Type | Description |
| -------------- | ------ | -------------------------------------- |
| X-RapidAPI-Key | string | Provide this header for authentication |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": [
{
"competition_name": "Eredivisie",
"distance_between_teams": 131,
"id": 40838,
"competition_cluster": "Netherlands",
"stadium_capacity": 51117,
"start_date": "2018-12-06T19:00:00",
"field_length": 105,
"home_strength": 2.31326526289031,
"available_markets": [
"btts",
"over_25",
"away_over_15",
"home_over_15",
"classic",
"home_over_05"
],
"field_width": 68,
"away_team": "VVV-Venlo",
"season": "2018 - 2019",
"last_update_at": "2018-12-04T20:11:57.506000",
"result": "",
"away_strength": 0.524973751312434,
"federation": "UEFA",
"home_team": "Feyenoord",
"is_expired": false,
"prediction_per_market": {
"home_over_05": {
"prediction": "yes",
"status": "pending",
"odds": {
"no": null,
"yes": null
},
"probabilities": {
"no": 0.248,
"yes": 0.752
}
},
"away_over_15": {
"prediction": "no",
"status": "pending",
"odds": {
"no": null,
"yes": null
},
"probabilities": {
"no": 0.706,
"yes": 0.294
}
},
"over_25": {
"prediction": "yes",
"status": "pending",
"odds": {
"no": 2.497,
"yes": 1.493
},
"probabilities": {
"no": 0.377,
"yes": 0.623
}
},
"btts": {
"prediction": "no",
"status": "pending",
"odds": {
"no": 1.708,
"yes": 2.047
},
"probabilities": {
"no": 0.547,
"yes": 0.453
}
},
"home_over_15": {
"prediction": "yes",
"status": "pending",
"odds": {
"no": null,
"yes": null
},
"probabilities": {
"no": 0.238,
"yes": 0.762
}
},
"classic": {
"prediction": "1",
"status": "pending",
"odds": {
"X2": 4.03,
"2": 12.205,
"1X": 1.04,
"1": 1.217,
"12": 1.1,
"X": 6.168
},
"probabilities": {
"X2": 0.458,
"2": 0.163,
"1X": 0.837,
"1": 0.542,
"12": 0.704,
"X": 0.296
}
}
}
}
]
}
```
{% endtab %}
{% endtabs %}
## Performance stats (accuracy)
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/performance-stats`
This endpoint returns information about the accuracy of the past predictions. (in the last day, 7 days, 14 days and 30 days)\
Can be additionally filtered by federation and market.\
If no market filter is provided it defaults to **classic**
#### Query Parameters
| Name | Type | Description |
| ---------- | ------ | ------------------------------------------------------------------------------------------ |
| federation | string | Football association, for accepted values check the /api/v2/list-federations the response. |
| market | string | Check the table above for the accepted values and how it affects the response. |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"market": "classic",
"accuracy": {
"last_30_days": 0.6819056785370549,
"last_14_days": 0.6704653371320038,
"yesterday": 0.78125,
"last_7_days": 0.6799242424242424
},
"details": {
"last_30_days": {
"pending": 0,
"lost": 661,
"postponed": 26,
"won": 1417,
"total": 2104
},
"last_14_days": {
"pending": 0,
"lost": 347,
"postponed": 14,
"won": 706,
"total": 1067
},
"yesterday": {
"pending": 0,
"lost": 7,
"postponed": 0,
"won": 25,
"total": 32
},
"last_7_days": {
"pending": 0,
"lost": 169,
"postponed": 7,
"won": 359,
"total": 535
}
}
}
}
```
{% endtab %}
{% endtabs %}
## List Federations
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/list-federations`
Returns a list of the supported federations.\
Takes no parameter.
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": [
"UEFA",
"AFC",
"CAF",
"CONCACAF",
"OFC",
"CONMEBOL"
]
}
```
{% endtab %}
{% endtabs %}
## List Markets
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/list-markets`
List all available markets and the ones that are enabled for your subscription plan.
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"all": [
"over_35",
"away_over_15",
"home_over_15",
"classic",
"home_over_05",
"over_25",
"away_over_05",
"btts"
],
"allowed_for_your_subscription": [
"over_35",
"away_over_15",
"home_over_15",
"classic",
"home_over_05",
"over_25",
"away_over_05",
"btts"
]
}
}
```
{% endtab %}
{% endtabs %}
## League stats for home team
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/home-league-stats/:id`
Given a match`id` will grab the league stats for the team playing at home.\
**Does** **not** **support past results only upcoming matches** (with the start\_date in the future)
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ----------- |
| id | integer | Fixture ID |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"points_as_home_team": 13,
"goals_scored": 26,
"matches_played": 16,
"won": 8,
"lost": 5,
"goals_scored_as_home_team": 15,
"goals_conceived_as_home_team": 7,
"matches_played_as_home_team": 7,
"points": 27,
"lost_as_home_team": 2,
"won_as_home_team": 4,
"draw_as_home_team": 1,
"goals_conceived": 18,
"team": "Real Sociedad",
"draw": 3
}
}
```
{% endtab %}
{% endtabs %}
## Head to Head
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/head-to-head/:id`
Shows head to head stats and previous encounters for the home and away team of an upcoming match.
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | number | Fixture ID |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"stats": {
"overall": {
"num_encounters": 10,
"over_05": 10,
"total_goals": 33,
"over_35": 4,
"over_25": 6,
"both_teams_scored": 6,
"over_15": 7,
"avg_goals_per_match": 3.3
},
"away_team": {
"goals_scored": 23,
"team_name": "Barcelona",
"clean_sheet": 3,
"won": 8,
"lost": 1,
"first_half_draw": 2,
"avg_goals_scored": 2.3,
"avg_bookie_draw_chance": 0.161,
"avg_bookie_lose_chance": 0.098,
"avg_goals_conceived": 1,
"first_half_lost": 3,
"first_half_win": 5,
"avg_bookie_win_chance": 0.751,
"goals_conceived": 10,
"draw": 1
},
"home_team": {
"goals_scored": 10,
"team_name": "Real Sociedad",
"clean_sheet": 1,
"won": 1,
"lost": 8,
"first_half_draw": 2,
"avg_goals_scored": 1,
"avg_bookie_draw_chance": 0.161,
"avg_bookie_lose_chance": 0.751,
"avg_goals_conceived": 2.3,
"first_half_lost": 5,
"first_half_win": 3,
"avg_bookie_win_chance": 0.098,
"goals_conceived": 23,
"draw": 1
}
},
"encounters": [
{
"first_half_result": "1 - 0",
"competition_cluster": "Spain",
"fulltime_result": "2 - 1",
"start_date": "2019-04-20",
"competition_name": "Primera Division",
"season": "2018 - 2019",
"away_team": "Real Sociedad",
"home_team": "Barcelona"
},
{
"first_half_result": "1 - 0",
"competition_cluster": "Spain",
"fulltime_result": "1 - 2",
"start_date": "2018-09-15",
"competition_name": "Primera Division",
"season": "2018 - 2019",
"away_team": "Barcelona",
"home_team": "Real Sociedad"
},
{
"first_half_result": "0 - 0",
"competition_cluster": "Spain",
"fulltime_result": "1 - 0",
"start_date": "2018-05-20",
"competition_name": "Primera Division",
"season": "2017 - 2018",
"away_team": "Real Sociedad",
"home_team": "Barcelona"
},
{
"first_half_result": "2 - 1",
"competition_cluster": "Spain",
"fulltime_result": "2 - 4",
"start_date": "2018-01-14",
"competition_name": "Primera Division",
"season": "2017 - 2018",
"away_team": "Barcelona",
"home_team": "Real Sociedad"
},
{
"first_half_result": "3 - 2",
"competition_cluster": "Spain",
"fulltime_result": "3 - 2",
"start_date": "2017-04-15",
"competition_name": "Primera Division",
"season": "2016 - 2017",
"away_team": "Real Sociedad",
"home_team": "Barcelona"
},
{
"first_half_result": "1 - 0",
"competition_cluster": "Spain",
"fulltime_result": "5 - 2",
"start_date": "2017-01-26",
"competition_name": "Copa del Rey",
"season": "2016 - 2017",
"away_team": "Real Sociedad",
"home_team": "Barcelona"
},
{
"first_half_result": "0 - 1",
"competition_cluster": "Spain",
"fulltime_result": "0 - 1",
"start_date": "2017-01-19",
"competition_name": "Copa del Rey",
"season": "2016 - 2017",
"away_team": "Barcelona",
"home_team": "Real Sociedad"
},
{
"first_half_result": "0 - 0",
"competition_cluster": "Spain",
"fulltime_result": "1 - 1",
"start_date": "2016-11-27",
"competition_name": "Primera Division",
"season": "2016 - 2017",
"away_team": "Barcelona",
"home_team": "Real Sociedad"
},
{
"first_half_result": "1 - 0",
"competition_cluster": "Spain",
"fulltime_result": "1 - 0",
"start_date": "2016-04-09",
"competition_name": "Primera Division",
"season": "2015 - 2016",
"away_team": "Barcelona",
"home_team": "Real Sociedad"
},
{
"first_half_result": "2 - 0",
"competition_cluster": "Spain",
"fulltime_result": "4 - 0",
"start_date": "2015-11-28",
"competition_name": "Primera Division",
"season": "2015 - 2016",
"away_team": "Real Sociedad",
"home_team": "Barcelona"
}
]
}
}
```
{% endtab %}
{% endtabs %}
## League stats for away team
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/away-league-stats/:id`
Given a match `id` will grab the league stats for the team playing away.\
**Does not support past results only upcoming matches** (with the start\_date in the future)
#### Path Parameters
| Name | Type | Description |
| ---- | ------- | ----------- |
| id | integer | Fixture ID |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"points_as_away_team": 13,
"won_as_away_team": 4,
"goals_scored": 41,
"matches_played": 15,
"won": 11,
"lost": 3,
"lost_as_away_team": 3,
"goals_conceived_as_away_team": 9,
"draw_as_away_team": 1,
"points": 34,
"goals_scored_as_away_team": 11,
"matches_played_as_away_team": 8,
"goals_conceived": 18,
"team": "Barcelona",
"draw": 1
}
```
{% endtab %}
{% endtabs %}
## Last 10 matches for Home team
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/home-last-10/`
Shows the last 10 encounters for the home team and statistics based on those last 10 matches.\
Less than 10 encounters are shown when more data is not available
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | number | Fixture ID |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"stats": {
"lost_as_away_team": 1,
"goals_scored": 13,
"wins_as_home_team": 2,
"results_as_home_team": "WLDLW",
"clean_sheets": 0,
"goals_conceived_as_away_team": 4,
"goals_scored_as_home_team": 9,
"draws": 3,
"results_as_away_team": "DWWLD",
"wins": 4,
"over_35": 3,
"over_25": 5,
"num_played_as_home_team": 5,
"goals_conceived_first_half": 6,
"lost_as_home_team": 2,
"goals_scored_as_away_team": 4,
"goals_scored_second_half": 8,
"over_15": 6,
"num_played_as_away_team": 5,
"draws_as_away_team": 2,
"lost": 3,
"results": "DWWLWDLLWD",
"draws_as_home_team": 1,
"wins_as_away_team": 2,
"over_05": 8,
"goals_conceived_second_half": 4,
"goals_conceived_as_home_team": 6,
"goals_scored_first_half": 5,
"both_teams_scored": 6,
"goals_conceived": 10
},
"encounters": [
{
"odds_against": 3.37,
"result": "D",
"played_against": "Valladolid",
"fulltime_result": "0 - 0",
"odds_draw": 3.25,
"goals_scored_first_half": 0,
"position": 1,
"start_date": "2019-12-08",
"odds_for": 2.25,
"played_away": true
},
{
"odds_against": 5.4,
"result": "W",
"played_against": "Eibar",
"fulltime_result": "4 - 1",
"odds_draw": 3.87,
"goals_scored_first_half": 1,
"position": 2,
"start_date": "2019-11-30",
"odds_for": 1.66,
"played_away": false
},
{
"odds_against": 1.36,
"result": "L",
"played_against": "Real Madrid",
"fulltime_result": "3 - 1",
"odds_draw": 5.49,
"goals_scored_first_half": 1,
"position": 3,
"start_date": "2019-11-23",
"odds_for": 7.65,
"played_away": true
},
{
"odds_against": 4.68,
"result": "L",
"played_against": "Osasuna",
"fulltime_result": "0 - 1",
"odds_draw": 3.76,
"goals_scored_first_half": 0,
"position": 4,
"start_date": "2019-11-14",
"odds_for": 1.58,
"played_away": false
},
{
"odds_against": 5.59,
"result": "D",
"played_against": "Leganes",
"fulltime_result": "1 - 1",
"odds_draw": 3.52,
"goals_scored_first_half": 0,
"position": 5,
"start_date": "2019-11-08",
"odds_for": 1.71,
"played_away": false
},
{
"odds_against": 2.92,
"result": "W",
"played_against": "Granada CF",
"fulltime_result": "1 - 2",
"odds_draw": 3.15,
"goals_scored_first_half": 1,
"position": 6,
"start_date": "2019-11-03",
"odds_for": 2.59,
"played_away": true
},
{
"odds_against": 6.42,
"result": "L",
"played_against": "Levante",
"fulltime_result": "1 - 2",
"odds_draw": 4.58,
"goals_scored_first_half": 0,
"position": 7,
"start_date": "2019-10-30",
"odds_for": 1.49,
"played_away": false
},
{
"odds_against": 2.79,
"result": "W",
"played_against": "Celta Vigo",
"fulltime_result": "0 - 1",
"odds_draw": 3.29,
"goals_scored_first_half": 0,
"position": 8,
"start_date": "2019-10-27",
"odds_for": 2.58,
"played_away": true
},
{
"odds_against": 3.83,
"result": "W",
"played_against": "Real Betis",
"fulltime_result": "3 - 1",
"odds_draw": 3.7,
"goals_scored_first_half": 2,
"position": 9,
"start_date": "2019-10-20",
"odds_for": 1.94,
"played_away": false
},
{
"odds_against": 2.45,
"result": "D",
"played_against": "Osasuna",
"fulltime_result": "0 - 0",
"odds_draw": 3.53,
"goals_scored_first_half": 0,
"position": 10,
"start_date": "2019-10-10",
"odds_for": 2.42,
"played_away": true
}
]
}
}
```
{% endtab %}
{% endtabs %}
## Last 10 matches for Away team
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/away-last-10/`
Shows the last 10 encounters for the home team and statistics based on those last 10 matches.\
Less than 10 encounters are shown when more data is not available.
#### Path Parameters
| Name | Type | Description |
| ---- | ------ | ----------- |
| id | number | Fixture ID |
{% tabs %}
{% tab title="200 " %}
```javascript
{
"data": {
"stats": {
"lost_as_away_team": 1,
"goals_scored": 25,
"wins_as_home_team": 4,
"results_as_home_team": "WDWWW",
"clean_sheets": 0,
"goals_conceived_as_away_team": 5,
"goals_scored_as_home_team": 17,
"draws": 1,
"results_as_away_team": "LWWWW",
"wins": 8,
"over_35": 5,
"over_25": 7,
"num_played_as_home_team": 5,
"goals_conceived_first_half": 5,
"lost_as_home_team": 0,
"goals_scored_as_away_team": 8,
"goals_scored_second_half": 12,
"over_15": 8,
"num_played_as_away_team": 5,
"draws_as_away_team": 0,
"lost": 1,
"results": "WLDWWWWWWW",
"draws_as_home_team": 1,
"wins_as_away_team": 4,
"over_05": 9,
"goals_conceived_second_half": 5,
"goals_conceived_as_home_team": 5,
"goals_scored_first_half": 13,
"both_teams_scored": 7,
"goals_conceived": 10
},
"encounters": [
{
"odds_against": 1.57,
"result": "W",
"played_against": "Inter",
"fulltime_result": "1 - 2",
"odds_draw": 4.47,
"goals_scored_first_half": 1,
"position": 1,
"start_date": "2019-12-10",
"odds_for": 5.25,
"played_away": true
},
{
"odds_against": 23.93,
"result": "W",
"played_against": "Mallorca",
"fulltime_result": "5 - 2",
"odds_draw": 9.68,
"goals_scored_first_half": 4,
"position": 2,
"start_date": "2019-12-07",
"odds_for": 1.11,
"played_away": false
},
{
"odds_against": 2.84,
"result": "W",
"played_against": "Atletico Madrid",
"fulltime_result": "0 - 1",
"odds_draw": 3.22,
"goals_scored_first_half": 0,
"position": 3,
"start_date": "2019-12-01",
"odds_for": 2.62,
"played_away": true
},
{
"odds_against": 6.43,
"result": "W",
"played_against": "Borussia Dortmund",
"fulltime_result": "3 - 1",
"odds_draw": 4.78,
"goals_scored_first_half": 2,
"position": 4,
"start_date": "2019-11-27",
"odds_for": 1.46,
"played_away": false
},
{
"odds_against": 6.09,
"result": "W",
"played_against": "Leganes",
"fulltime_result": "1 - 2",
"odds_draw": 4.29,
"goals_scored_first_half": 0,
"position": 5,
"start_date": "2019-11-23",
"odds_for": 1.54,
"played_away": true
},
{
"odds_against": 3.94,
"result": "W",
"played_against": "Cartagena",
"fulltime_result": "0 - 2",
"odds_draw": 3.83,
"goals_scored_first_half": 0,
"position": 6,
"start_date": "2019-11-13",
"odds_for": 1.75,
"played_away": true
},
{
"odds_against": 12.51,
"result": "W",
"played_against": "Celta Vigo",
"fulltime_result": "4 - 1",
"odds_draw": 7.02,
"goals_scored_first_half": 2,
"position": 7,
"start_date": "2019-11-09",
"odds_for": 1.21,
"played_away": false
},
{
"odds_against": 12.5,
"result": "D",
"played_against": "Slavia Prague",
"fulltime_result": "0 - 0",
"odds_draw": 6.26,
"goals_scored_first_half": 0,
"position": 8,
"start_date": "2019-11-05",
"odds_for": 1.23,
"played_away": false
},
{
"odds_against": 8.43,
"result": "L",
"played_against": "Levante",
"fulltime_result": "3 - 1",
"odds_draw": 6.16,
"goals_scored_first_half": 1,
"position": 9,
"start_date": "2019-11-02",
"odds_for": 1.31,
"played_away": true
},
{
"odds_against": 21.37,
"result": "W",
"played_against": "Valladolid",
"fulltime_result": "5 - 1",
"odds_draw": 9.62,
"goals_scored_first_half": 3,
"position": 10,
"start_date": "2019-10-29",
"odds_for": 1.12,
"played_away": false
}
]
}
}
```
{% endtab %}
{% endtabs %}
## Get a list of Fixture IDs
`GET` `https://football-prediction-api.p.rapidapi.com/api/v2/get-list-of-fixture-ids`
This endpoint returns an array of fixture ids.\
It is recommended to use this endpoint if you plan to query the Prediction Details endpoint or other endpoints that need a fixture ID as URL parameter.
#### Query Parameters
| Name | Type | Description |
| ---------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| iso\_date | string | Date in YYYY-MM-DD format
Day starts at 00:00 London timezone
If not provided returns predictions with start\_date > current time
|
| market | string | Market - check prediction endpoint for details |
| federation | string | The football association |
#### Headers
| Name | Type | Description |
| -------------- | ------ | ------------------------- |
| X-RapidAPI-Key | string | Needed for authentication |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: 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:
```
GET https://developer.boggio-analytics.com/getting-started/api-endpoints.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.