Skip to content

Latest commit

 

History

History
85 lines (59 loc) · 2.61 KB

README.md

File metadata and controls

85 lines (59 loc) · 2.61 KB

MCBanners/mc-api

Service designed to interact with Minecraft Servers and return JSON data on the status of the server.

API Reference

Base URL: https://api.mcbanners.com

Supported Platforms (and their parameter type)

spigot -> number
sponge -> string
curseforge -> number

Check valid author

  GET /author/${platform}/${id}/isValid
Parameter Type Description
platform string Platform type from the above list
id string or number The id in the form from the above list

Get author banner

  GET /author/${platform}/${id}/banner.${outputType}
Parameter Type Description
platform string Platform type from the above list
id string or number The id in the form from the above list
outputType string Either png or jpg

Check valid resource

  GET /resource/${platform}/${id}/isValid
Parameter Type Description
platform string Platform type from the above list
id string or number The id in the form from the above list

Get resource banner

  GET /resource/${platform}/${id}/banner.${outputType}
Parameter Type Description
platform string Platform type from the above list
id string or number The id in the form from the above list
outputType string Either png or jpg

Check valid server

  GET /server/${host}/${port}/isValid
Parameter Type Description
host string The server ip
port number The server port

Get server banner

  GET /server/${host}/${port}/banner.${outputType}
Parameter Type Description
host string The server ip
port number The server port
outputType string Either png or jpg