# /boosters

{% hint style="info" %}
This endpoint supports the [Exclude](https://dadocs.rickyjs.xyz/exclude-header) header
{% endhint %}

### Endpoint Headers:

* bot-token - Token of the Bot <mark style="color:orange;">**\[String]**</mark> (<mark style="color:red;">**Required**</mark>)
* apikey - Your Api Auth Key <mark style="color:orange;">**\[String]**</mark> (<mark style="color:red;">**Required**</mark>)
* guild-id - ID of the guild to be fetched <mark style="color:orange;">**\[Snowflake]**</mark> (<mark style="color:red;">**Required**</mark>)&#x20;

### Endpoint URL Parameters

* simple - Retrieves a simpler set of data <mark style="color:orange;">**\[Boolean]**</mark> (<mark style="color:green;">**Optional**</mark>)

### Examples:

{% hint style="info" %}
Data API version required. Must replace `<version>` with either **release** or **beta**.
{% endhint %}

<details>

<summary>Bot Designer for Discord</summary>

Example usage of `/guild/boosters` endpoint using BDFD

```bash
$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/boosters]


$httpResult OR $httpResult[details]
```

OR

```bash
$httpAddHeader[apikey;<YOUR-API-KEY>]
$httpAddHeader[bot-token;<YOUR-BOT-TOKEN>]
$httpAddHeader[guild-id;1064098700307218463] 
$httpGet[https://bdfddata.rickyjs.xyz/<version>/guild/boosters?simple=true]


$httpResult OR $httpResult[details]
```

</details>

<details>

<summary>Discord.js</summary>

Example usage of `/guild/boosters` endpoint using Discord.js

```javascript
const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/boosters', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463"
}
}).then(res=>res.data)
})()
```

OR

```javascript
const axios = require('axios');
(async () => {
return await axios.get('https://bdfddata.rickyjs.xyz/<version>/guild/boosters?simple=true', {
headers: {
"apikey": "<YOUR-API-KEY>",
"bot-token": "<YOUR-BOT-TOKEN>",
"guild-id": "1064098700307218463"
}
}).then(res=>res.data)
})()
```

</details>

### Possible Responses (Codes)

<details>

<summary>Code 200 (Simple Not Used)</summary>

API succeeded and details were fetched.

```javascript
{
  status: 200,
  details: [
    {
      "avatar": null,
      "communication_disabled_until": null,
      "flags": 0,
      "is_pending": false,
      "joined_at": "1673771300",
      "nick": null,
      "pending": false,
      "premium_since": null,

   >  'Read on `Member Objects` : https://discord.com/developers/docs/resources/guild#guild-member-object' 
    ]
}
```

</details>

<details>

<summary>Code 200 (Simple Used)</summary>

API succeeded and details were fetched.

```javascript
{
  status: 200,
  details:  {
        "boosters": [{
            "id": "516551416064770059",
            "premium_since": "1750169844"
        }],// array of userids and the timestamp of when boosting started
        "boostCount": 1 // total boost coint
    },
```

</details>

<details>

<summary>Code 400</summary>

An error occurred that stopped execution.

```javascript
{
    status: 400
    error: 'Cannot read ...  (This can vary)'
}
```

</details>

<details>

<summary>Code 401</summary>

Invalid bot token was provided.

```javascript
{
  status: 401,
  details: { message: '401: Unauthorized', code: 0 }
}
```

</details>

<details>

<summary>Code 404</summary>

Guild was not found via DAPI

```javascript
{
  status: 404,
  details: { message: 'Unknown Guild', code: 10004 } (this can vary)
}
```

</details>