Home

Welcome to the minebook-api-docs wiki!

Tutorials

For tutorials, go to Tutorials

API Overview

This is a REST api. All server responses are in JSON format

Unless otherwise stated, Max API request from the same access token or host is limited to 45 per 30 seconds and 450 per 600 seconds.

Please note that only GET requests are currently implemented, plus limited POST requests for posting comments.

Legends

• Requires Auth: whether you need to attach an access_token to the request url. To accquire an access_token, authenticate your client with GET /player/:playername/auth
• Implemented: You can try this out right now

HTTP Response Codes

The HTTP response codes that the API uses are listed below:

• 200 OK/Success
• 201 Created
• 204 No Content
• 206 Partial Content
• 400 Bad Request
• 401 Unauthorized
• 403 Forbidden
• 404 Not Found
• 409 Conflict
• 429 Too Many Requests
• 500 Internal Server Error
• 503 Service Unavailable

Table of Contents

For detailed documentations, please go to these individual sections:

• Player
• Friends
• Posts
• Gallery
• Server
• Search and Browse