Java server MOTD

GET

/java/motd

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.mcquery.net/java/motd?target=mc.hypixel.net&port=25565&players=true"

  req, _ := http.NewRequest("GET", url, nil)

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.mcquery.net/java/motd?target=mc.hypixel.net&port=25565&players=true"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.mcquery.net/java/motd?target=mc.hypixel.net&port=25565&players=true")
  .get()
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.mcquery.net/java/motd',
  params: {target: 'mc.hypixel.net', port: '25565', players: 'true'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.mcquery.net/java/motd?target=mc.hypixel.net&port=25565&players=true';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.mcquery.net/java/motd";

    let querystring = [
        ("target", "mc.hypixel.net"),
        ("port", "25565"),
        ("players", "true"),
    ];

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

Renders and returns the server’s MOTD as a PNG image that resembles the in-game server list

Parameters

Query Parameters

target

required

string

Minecraft server hostname or IP.

Example

mc.hypixel.net

port

required

integer

>= 1 <= 65535

TCP port (1-65535).

Example

players

boolean

default: true

Whether to render the player count (default true). Set to false/0/no/off to omit it.

Example

true

Responses

200

PNG image of the server’s MOTD (rendered for both reachable and unreachable servers)

image/png

string format: binary

Headers

RateLimit

string

IETF-draft combined rate-limit header for the current window: limit, remaining, and reset (seconds until the window resets). Sent on every response from a known endpoint.

Example

limit=120, remaining=119, reset=42

RateLimit-Limit

integer

Maximum requests allowed per client IP per window (120 requests per 60s).

Example

RateLimit-Remaining

integer

Requests remaining in the current window before the limit is hit.

Example

RateLimit-Reset

integer

Seconds until the current window resets.

Example

400

Missing or invalid parameter

application/json

Error response.

object

required

boolean

msg

required

string

Example

{
  "ok": false,
  "msg": "query param target is required"
}

Headers

RateLimit

string

IETF-draft combined rate-limit header for the current window: limit, remaining, and reset (seconds until the window resets). Sent on every response from a known endpoint.

Example

limit=120, remaining=119, reset=42

RateLimit-Limit

integer

Maximum requests allowed per client IP per window (120 requests per 60s).

Example

RateLimit-Remaining

integer

Requests remaining in the current window before the limit is hit.

Example

RateLimit-Reset

integer

Seconds until the current window resets.

Example

403

Target resolves to a private/reserved address

application/json

Error response.

object

required

boolean

msg

required

string

Example

{
  "ok": false,
  "msg": "target doesn't resolve to a public addr"
}

Headers

RateLimit

string

IETF-draft combined rate-limit header for the current window: limit, remaining, and reset (seconds until the window resets). Sent on every response from a known endpoint.

Example

limit=120, remaining=119, reset=42

RateLimit-Limit

integer

Maximum requests allowed per client IP per window (120 requests per 60s).

Example

RateLimit-Remaining

integer

Requests remaining in the current window before the limit is hit.

Example

RateLimit-Reset

integer

Seconds until the current window resets.

Example

429

Rate limit exceeded: more than 120 requests were made from one client IP within a 60-second window.

application/json

Error response.

object

required

boolean

msg

required

string

Example

{
  "ok": false,
  "msg": "you're being rate limited, try again later."
}

Headers

RateLimit

string

IETF-draft combined rate-limit header for the current window: limit, remaining, and reset (seconds until the window resets). Sent on every response from a known endpoint.

Example

limit=120, remaining=119, reset=42

RateLimit-Limit

integer

Maximum requests allowed per client IP per window (120 requests per 60s).

Example

RateLimit-Remaining

integer

Requests remaining in the current window before the limit is hit.

Example

RateLimit-Reset

integer

Seconds until the current window resets.

Example

Retry-After

integer

Seconds to wait before retrying. Sent only on a 429 response.