๐Ÿ“„ Public API Documentation

API Reference#

AutoPlus's API is based on a HTTPS/REST architecture. The API is there mostly to be used in the website autoplus.gg but some endpoints can be used to integrate AutoPlus in your own projects.

Base URL#

https://api.autoplus.gg/v{version}

Where {version} is the API version you want to use. Currently, the only version available is v1.

Authentication#

Some endpoints require authentication. You can authenticate using a api key in the Authorization header.

Example:#

Authorization: h27FGjb3AyjVkGBzRThH

Where h27FGjb3AyjVkGBzRThH is your api key. To get your API key, open a support ticket.

Crypto type#

This refers to the crypto/token that the bot supports. Here is the exact type:

"ltc" | "sol" | "eth" | "sol_usdt" | "sol_usdc" | "eth_usdt" | "eth_usdc"

Endpoints#

Here are the available endpoints:

GET

/servers

#

Get the list of all servers the bot is in.

Response Structure#

Each object in the array has the following structure:

FieldTypeDescription
idstringThe server ID
namestringThe server name
iconstringThe server icon URL

GET

/stats

#

Get the stats of the whole bot.

Response Structure#

FieldTypeDescription
tradesnumberThe number total of trades made on the bot (completed + canceled)
volumenumberThe total volume in USD of trades made on the bot (completed + canceled)
canceledTradesnumberThe number of trades canceled on the bot
canceledVolumenumberThe total volume in USD of trades canceled on the bot
trades24hnumberThe number of trades made on the bot in the last 24h (completed + canceled)
volume24hnumberThe total volume in USD of trades made on the bot in the last 24h (completed + canceled)

GET

/transactions

#

Get the 10 most recent transactions made on the bot.

Response Structure#

Each object in the array has the following structure:

FieldTypeDescription
cryptocryptoThe crypto used in the transaction
amountnumberThe amount of crypto handled in the transaction
amountUsdnumberThe amount of crypto in USD handled in the transaction
txidstringThe transaction ID of the bot receiving the funds
txid2stringThe transaction ID of the bot releasing the funds
receivedAtnumberThe timestamp of when the bot received the funds, in seconds since unix epoch
closedAtnumberThe timestamp of when the bot closed the trade, in seconds since unix epoch

POST

/guilds/{guildId}/trades

#

Open a trade with the bot.

Request Structure#

This request requires authentication.

FieldTypeDescription
userId1stringThe user ID of the first user
userId2stringThe user ID of the second user
cryptocryptoThe crypto used in the transaction

Response Structure#

FieldTypeDescription
messagestringThe response message
threadId?string | undefinedThe channel ID of the thread created for the trade