https://github.com/rocketleagueapi/tradebot-api-types

Typings for the Rocket League Tradebot API.
https://github.com/rocketleagueapi/tradebot-api-types

nodejs rocket-league rocket-league-bot socket-io trading trading-bot typescript typings

Last synced: 22 days ago
JSON representation

Typings for the Rocket League Tradebot API.

• Host: GitHub
• URL: https://github.com/rocketleagueapi/tradebot-api-types
• Owner: rocketleagueapi
• License: lgpl-3.0
• Created: 2022-02-22T05:39:29.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-18T16:28:55.000Z (4 months ago)
• Last Synced: 2024-10-02T05:02:21.668Z (about 1 month ago)
• Topics: nodejs, rocket-league, rocket-league-bot, socket-io, trading, trading-bot, typescript, typings
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@rocketleagueapi/tradebot-api-types
• Size: 212 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Rocket League Tradebot API Types



    

  

  

  

    

  



An up to date type library for the Tradebot API, to be used with Socket.IO.


### 🏠 [Homepage](https://github.com/rocketleagueapi/tradebot-api-types)

## Install

Install this package using your package manager of choice.

```sh

 npm i @rocketleagueapi/tradebot-api-types

```

or

```sh

 yarn add @rocketleagueapi/tradebot-api-types

```

## Example Usage

```ts

import { ListenEvents, EmitEvents } from '@rocketleagueapi/tradebot-api-types'

import io, { Socket } from 'socket.io-client';

const socket: Socket = io('https://tradebot.anga.blue', {

    auth: {

        key: process.env.TRADEBOT_API_KEY

    }

});

socket.on('connect', () => {

    console.log('Connected to Tradebot API');

    socket.emit('getItems', console.log);

});

```

## 📝 License

Copyright © 2021 [Rocket League API](https://github.com/rocketleagueapi).


This project is [LGPL--3.0--or--later](https://github.com/rocketleagueapi/tradebot-api-types/blob/master/LICENSE) licensed.