Skip to main content

​
Welcome to JDA

JDA (Java Discord API) is an open source library for implementing bots on Discord using the real-time gateway and REST API. It provides event-based functionality to implement bots of any kind, allowing for effective and scalable applications.

Installation

Get started with JDA using Gradle or Maven

Quick Start

Build your first Discord bot in minutes

API Reference

Explore the complete JDA Javadocs

Wiki

Deep dive into JDA concepts and guides

​
Core Concepts

JDA has been developed with scalability and ease of use in mind, providing three core concepts:

​
Event System

Providing simplified events from the gateway API, to respond to any platform events in real-time without much hassle. 
public class MyListener extends ListenerAdapter {
    @Override
    public void onMessageReceived(MessageReceivedEvent event) {
        if (event.getMessage().getContentRaw().equals("!ping")) {
            event.getChannel().sendMessage("Pong!").queue();
        }
    }
}

​
Rest Actions

Easy to use and scalable implementation of REST API functionality, letting you choose between callbacks with combinators, futures, and blocking. The library also handles rate-limits imposed by Discord automatically. 
channel.sendMessage("Hello Friend!")
    .addFiles(FileUpload.fromData(greetImage))
    .queue() // Send the request asynchronously
The final call to queue() sends the request. You can also send requests synchronously or using futures.

​
Customizable Cache

Trading memory usage for better performance where necessary, with sane default presets to choose from and customize. JDA provides different builder presets:
  • createDefault - Enables cache for users who are active in voice channels and all cache flags
  • createLight - Disables all user cache and cache flags
  • create - Enables member chunking, caches all users, and enables all cache flags
Read the guide on caching and intents to configure your bot properly.

​
Requirements

The minimum Java version supported by JDA is Java SE 8. JDA also uses JSR 305 to support solid interoperability with Kotlin out of the box.

​
Next Steps

Install JDA

Add JDA to your project with Gradle or Maven

Build Your First Bot

Follow our quick start guide to create a working bot

Build docs developers (and LLMs) love

Get started for freeTalk to us