npm package: @ggbot/sdk
Description: OpenAPI client for @ggbot/sdk
Author: OpenAPI-Generator Contributors
Latest version: 0.14.2

# GGBot API SDK

@ggbot/sdk
- API version: 0.14.2
- Package version: 0.14.2
- Build date: 2025-11-26T19:24:06.634114673Z[Etc/UTC]

The GGBot API allows developers to interact with the GGBot platform, managing bots, modules, and retrieving statistics. 

For more information, visit [https://api-docs.ggbot.de/](https://api-docs.ggbot.de/)

---

## Requirements

- Node.js 14+
- TypeScript 4.0+

---

## Installation

Download the latest SDK from:

➡ [https://api-docs.ggbot.de/](https://api-docs.ggbot.de/)

### Install locally:

```shell
cd ggbot-sdk-ts
npm install
npm run build
```

### Alternatively you can run:
```shell
npm install @ggbot/sdk
```

### Link to your project:

```shell
cd ggbot-sdk-ts
npm link

cd /path/to/your/project
npm link @ggbot/sdk
```

Or copy the entire SDK folder to your project and install:

```shell
npm install ./path/to/ggbot-sdk-ts
```

---

## Getting Started

```typescript
import { Configuration, BotsApi } from '@ggbot/sdk';

const configuration = new Configuration({
    basePath: 'https://api.ggbot.de/api',
    accessToken: 'YOUR_ACCESS_TOKEN'
});

const apiInstance = new BotsApi(configuration);

apiInstance.addUserToBotCommand('token_example', 'command_example', 'user_example')
    .then(() => {
        console.log('API called successfully.');
    })
    .catch((error: any) => console.error(error));
```

---

## API Endpoints

All URIs are relative to `https://api.ggbot.de/api`.


### AuthenticationApi

| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**createApiKey**](docs/AuthenticationApi.md#createApiKey) | **POST** /apikeys | Create API Key |
| [**listApiKeys**](docs/AuthenticationApi.md#listApiKeys) | **GET** /apikeys | List API Keys |
| [**listOAuthTokens**](docs/AuthenticationApi.md#listOAuthTokens) | **GET** /oauth/tokens | List OAuth Tokens |
| [**revokeApiKey**](docs/AuthenticationApi.md#revokeApiKey) | **DELETE** /apikeys/{keyId} | Revoke API Key |
| [**revokeOAuthToken**](docs/AuthenticationApi.md#revokeOAuthToken) | **DELETE** /oauth/tokens/{tokenId} | Revoke OAuth Token |
| [**revokeOAuthTokensByClient**](docs/AuthenticationApi.md#revokeOAuthTokensByClient) | **DELETE** /oauth/tokens/client/{clientId} | Revoke All Tokens for Client |


### BotsApi

| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**addUserToBotCommand**](docs/BotsApi.md#addUserToBotCommand) | **POST** /bot/{token}/command/{commandName}/add | Add User to Bot Command |
| [**getAllBots**](docs/BotsApi.md#getAllBots) | **GET** /bots | Get All Bots owned by User |
| [**getBotByToken**](docs/BotsApi.md#getBotByToken) | **GET** /bot/{token} | Get Bot by Token |
| [**getBotCommands**](docs/BotsApi.md#getBotCommands) | **GET** /bot/{token}/commands | Get Bot Commands |
| [**getBotLogs**](docs/BotsApi.md#getBotLogs) | **GET** /bot/{token}/logs | Get Bot Logs |
| [**getBotModules**](docs/BotsApi.md#getBotModules) | **GET** /bot/{token}/modules | Get Bot Modules |
| [**getBotSettings**](docs/BotsApi.md#getBotSettings) | **GET** /bot/{token}/settings | Get Bot Settings |
| [**getBotStatistics**](docs/BotsApi.md#getBotStatistics) | **GET** /bot/{token}/statistics | Get Bot Statistics |
| [**logMessageForBot**](docs/BotsApi.md#logMessageForBot) | **POST** /bot/{token}/logs | Log Message for Bot |
| [**removeUserFromBotCommand**](docs/BotsApi.md#removeUserFromBotCommand) | **POST** /bot/{token}/command/{commandName}/remove | Remove User from Bot Command |
| [**rotateBot**](docs/BotsApi.md#rotateBot) | **POST** /bot/{token}/rotate | Rotate Bot |
| [**sendCommandToBot**](docs/BotsApi.md#sendCommandToBot) | **POST** /bot/{token}/command | Send Command to Bot |
| [**startBot**](docs/BotsApi.md#startBot) | **POST** /bot/{token}/start | Start Bot |
| [**stopBot**](docs/BotsApi.md#stopBot) | **POST** /bot/{token}/stop | Stop Bot |
| [**toggleBotModule**](docs/BotsApi.md#toggleBotModule) | **POST** /bot/{token}/module/{moduleName} | Toggle Bot Module |
| [**updateBotKeyboardState**](docs/BotsApi.md#updateBotKeyboardState) | **POST** /bot/{token}/keyboardstate | Update Bot Keyboard State |
| [**updateBotSetting**](docs/BotsApi.md#updateBotSetting) | **PATCH** /bot/{token}/settings | Update a Bot Setting |


### IngameApi

| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**activateBlock**](docs/IngameApi.md#activateBlock) | **POST** /bot/{token}/block/activate | Activate Block |
| [**attackEntity**](docs/IngameApi.md#attackEntity) | **POST** /bot/{token}/attack | Attack Entity |
| [**breakBlock**](docs/IngameApi.md#breakBlock) | **POST** /bot/{token}/block/break | Break Block |
| [**closeWindow**](docs/IngameApi.md#closeWindow) | **POST** /bot/{token}/window/close | Close Window |
| [**dropBotItem**](docs/IngameApi.md#dropBotItem) | **POST** /bot/{token}/drop | Drop Item |
| [**followPlayer**](docs/IngameApi.md#followPlayer) | **POST** /bot/{token}/follow | Follow Player |
| [**getBotAllPlayers**](docs/IngameApi.md#getBotAllPlayers) | **GET** /bot/{token}/players | Get All Players |
| [**getBotBlock**](docs/IngameApi.md#getBotBlock) | **GET** /bot/{token}/block | Get Block At Position |
| [**getBotEffects**](docs/IngameApi.md#getBotEffects) | **GET** /bot/{token}/effects | Get Active Effects |
| [**getBotExperience**](docs/IngameApi.md#getBotExperience) | **GET** /bot/{token}/experience | Get Bot Experience |
| [**getBotFood**](docs/IngameApi.md#getBotFood) | **GET** /bot/{token}/food | Get Bot Food Level |
| [**getBotHealth**](docs/IngameApi.md#getBotHealth) | **GET** /bot/{token}/health | Get Bot Health |
| [**getBotInventory**](docs/IngameApi.md#getBotInventory) | **GET** /bot/{token}/inventory | Get Bot Inventory |
| [**getBotLocation**](docs/IngameApi.md#getBotLocation) | **GET** /bot/{token}/location | Get Bot Location |
| [**getBotNearbyEntities**](docs/IngameApi.md#getBotNearbyEntities) | **GET** /bot/{token}/entities | Get Nearby Entities |
| [**getBotNearbyPlayers**](docs/IngameApi.md#getBotNearbyPlayers) | **GET** /bot/{token}/near | Get Nearby Players |
| [**getContainerInfo**](docs/IngameApi.md#getContainerInfo) | **GET** /bot/{token}/container/info | Get Open Container Info |
| [**interactWithEntity**](docs/IngameApi.md#interactWithEntity) | **POST** /bot/{token}/interact | Interact with Entity |
| [**lookAtPosition**](docs/IngameApi.md#lookAtPosition) | **POST** /bot/{token}/look | Look At Position |
| [**openContainer**](docs/IngameApi.md#openContainer) | **POST** /bot/{token}/container/open | Open Container |
| [**placeBlock**](docs/IngameApi.md#placeBlock) | **POST** /bot/{token}/block/place | Place Block |
| [**selectBotSlot**](docs/IngameApi.md#selectBotSlot) | **POST** /bot/{token}/slot | Select Hotbar Slot |
| [**sendBotChat**](docs/IngameApi.md#sendBotChat) | **POST** /bot/{token}/chat | Send Chat Message |
| [**startPathfinding**](docs/IngameApi.md#startPathfinding) | **POST** /bot/{token}/pathfind | Start Pathfinding |
| [**stopFollowing**](docs/IngameApi.md#stopFollowing) | **DELETE** /bot/{token}/follow | Stop Following |
| [**stopPathfinding**](docs/IngameApi.md#stopPathfinding) | **DELETE** /bot/{token}/pathfind | Stop Pathfinding |
| [**useBotItem**](docs/IngameApi.md#useBotItem) | **POST** /bot/{token}/use | Use Item |


### ModulesApi

| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**addGiveaway**](docs/ModulesApi.md#addGiveaway) | **POST** /bot/{token}/modules/ggfeatures/giveaways | Add Giveaway |
| [**getGGFeaturesCityBuild**](docs/ModulesApi.md#getGGFeaturesCityBuild) | **GET** /bot/{token}/modules/ggfeatures/citybuild | Get Current CityBuild |
| [**getGGFeaturesCurrentPlot**](docs/ModulesApi.md#getGGFeaturesCurrentPlot) | **GET** /bot/{token}/modules/ggfeatures/plot | Get Current Plot |
| [**getGGFeaturesMoney**](docs/ModulesApi.md#getGGFeaturesMoney) | **GET** /bot/{token}/modules/ggfeatures/money | Get Bot Money |
| [**getGiveaways**](docs/ModulesApi.md#getGiveaways) | **GET** /bot/{token}/modules/ggfeatures/giveaways | Get Giveaways |
| [**getModuleSettings**](docs/ModulesApi.md#getModuleSettings) | **GET** /bot/{token}/modules/{module}/settings | Get Module Settings |
| [**getPublicBuyItems**](docs/ModulesApi.md#getPublicBuyItems) | **GET** /bot/{token}/modules/buy/items | Get Buy Items |
| [**getPublicSellItems**](docs/ModulesApi.md#getPublicSellItems) | **GET** /bot/{token}/modules/sell/items | Get Sell Items |
| [**getTicketMessages**](docs/ModulesApi.md#getTicketMessages) | **GET** /bot/{token}/modules/tickets/{ticketId}/messages | Get Ticket Messages |
| [**getTickets**](docs/ModulesApi.md#getTickets) | **GET** /bot/{token}/modules/tickets | Get Tickets |
| [**removeGiveaway**](docs/ModulesApi.md#removeGiveaway) | **DELETE** /bot/{token}/modules/ggfeatures/giveaways/{giveawayId} | Remove Giveaway |
| [**updateModuleSetting**](docs/ModulesApi.md#updateModuleSetting) | **PATCH** /bot/{token}/modules/{module}/settings | Update Module Setting |


### PublicApi

| Method | HTTP request | Description |
|--------|--------------|-------------|
| [**getPublicBot**](docs/PublicApi.md#getPublicBot) | **GET** /bot/public | Get Public Bot |
| [**getPublicBotByLink**](docs/PublicApi.md#getPublicBotByLink) | **GET** /bot/public/{linkName} | Get Public Bot by Link Name |
| [**getPublicModules**](docs/PublicApi.md#getPublicModules) | **GET** /modules | Get Public Modules |
| [**getPublicServers**](docs/PublicApi.md#getPublicServers) | **GET** /servers | Get Public Servers |


---

## Models

* [BlockAction](docs/BlockAction.md) — Block interaction action
* [BlockPosition](docs/BlockPosition.md) — A 3D block position in the Minecraft world
* [Bot](docs/Bot.md) — A detailed representation of a bot
* [BuyItem](docs/BuyItem.md) — An item that can be bought in the bot shop
* [ChatMessage](docs/ChatMessage.md) — A chat message to send
* [Command](docs/Command.md) — A command provided by a module
* [ContainerInfo](docs/ContainerInfo.md) — Information about an open container/window
* [CreateApiKey200Response](docs/CreateApiKey200Response.md)
* [CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
* [EntityTarget](docs/EntityTarget.md) — Target entity for Ingame
* [FollowPlayerRequest](docs/FollowPlayerRequest.md)
* [GetBotBlock200Response](docs/GetBotBlock200Response.md)
* [GetBotBlock200ResponseData](docs/GetBotBlock200ResponseData.md)
* [GetBotEffects200Response](docs/GetBotEffects200Response.md)
* [GetBotEffects200ResponseDataInner](docs/GetBotEffects200ResponseDataInner.md)
* [GetBotExperience200Response](docs/GetBotExperience200Response.md)
* [GetBotExperience200ResponseData](docs/GetBotExperience200ResponseData.md)
* [GetBotFood200Response](docs/GetBotFood200Response.md)
* [GetBotHealth200Response](docs/GetBotHealth200Response.md)
* [GetBotInventory200Response](docs/GetBotInventory200Response.md)
* [GetBotLocation200Response](docs/GetBotLocation200Response.md)
* [GetBotNearbyEntities200Response](docs/GetBotNearbyEntities200Response.md)
* [GetBotNearbyEntities200ResponseDataInner](docs/GetBotNearbyEntities200ResponseDataInner.md)
* [GetBotNearbyPlayers200Response](docs/GetBotNearbyPlayers200Response.md)
* [GetContainerInfo200Response](docs/GetContainerInfo200Response.md)
* [GetGGFeaturesCityBuild200Response](docs/GetGGFeaturesCityBuild200Response.md)
* [GetGGFeaturesCurrentPlot200Response](docs/GetGGFeaturesCurrentPlot200Response.md)
* [GetGGFeaturesMoney200Response](docs/GetGGFeaturesMoney200Response.md)
* [Giveaway](docs/Giveaway.md) — A giveaway entry in the GGFeatures module
* [GiveawayInput](docs/GiveawayInput.md) — Input for creating/updating a giveaway
* [Inventory](docs/Inventory.md) — The bot\&#39;s inventory
* [InventoryItem](docs/InventoryItem.md) — An item in the bot\&#39;s inventory
* [ItemDrop](docs/ItemDrop.md) — Item drop action
* [ListApiKeys200ResponseInner](docs/ListApiKeys200ResponseInner.md)
* [ListOAuthTokens200ResponseInner](docs/ListOAuthTokens200ResponseInner.md)
* [LogMessageForBotRequest](docs/LogMessageForBotRequest.md)
* [LookAtPositionRequest](docs/LookAtPositionRequest.md)
* [Module](docs/Module.md) — A module that can be used by bots
* [PathfindTarget](docs/PathfindTarget.md) — Pathfinding target
* [PlotInfo](docs/PlotInfo.md) — Information about the current plot
* [Position](docs/Position.md) — A 3D position in the Minecraft world
* [PublicBot](docs/PublicBot.md) — A public representation of a bot
* [RevokeApiKey200Response](docs/RevokeApiKey200Response.md)
* [RevokeOAuthTokensByClient200Response](docs/RevokeOAuthTokensByClient200Response.md)
* [SellItem](docs/SellItem.md) — An item that can be sold in the bot shop
* [SellItemPrice](docs/SellItemPrice.md) — The price of the item
* [SendBotChat200Response](docs/SendBotChat200Response.md)
* [SendCommandToBotRequest](docs/SendCommandToBotRequest.md)
* [Server](docs/Server.md) — A server the bot can connect to
* [SlotSelection](docs/SlotSelection.md) — Inventory slot selection
* [StatisticsEvent](docs/StatisticsEvent.md) — A single event returned in statistics results
* [StatisticsEventMetadata](docs/StatisticsEventMetadata.md) — A metadata key/value pair attached to an event
* [StatisticsGroup](docs/StatisticsGroup.md) — A grouped aggregation (e.g. by month) with a count
* [StatisticsQuery](docs/StatisticsQuery.md) — A query for bot statistics
* [StatisticsQueryFilters](docs/StatisticsQueryFilters.md)
* [StatisticsQueryFiltersMetadataInner](docs/StatisticsQueryFiltersMetadataInner.md)
* [StatisticsQuerySort](docs/StatisticsQuerySort.md)
* [StatisticsResult](docs/StatisticsResult.md) — The result of a statistics query
* [Ticket](docs/Ticket.md) — A support ticket
* [TicketMessage](docs/TicketMessage.md) — A message in a ticket
* [UpdateBotKeyboardStateRequest](docs/UpdateBotKeyboardStateRequest.md)
* [UpdateBotSettingRequest](docs/UpdateBotSettingRequest.md)
* [UpdateModuleSettingRequest](docs/UpdateModuleSettingRequest.md)
* [WindowClick](docs/WindowClick.md) — Window/chest interaction

---

## Author

admin@ggbot.de