📦Packages API

An API for getting information about packages hosted on our service

How to get a package

With this endpoint, obtaining any package becomes attainable by using the package ID. All that's required is to send a request to the specified endpoint, and it will return you with the essential data about the package.

Gets information about a package.

GET https://api.mcjoe21.com/v1/packages/get

Get data of a package.

Query Parameters

Name
Type
Description

id*

String

ID of the package

part

String

The item key that you want returned

Here is a demonstration illustrating the output you can expect when a request is sent to the get endpoint. This illustrative example serves to showcase the type of data that will be returned in response to your query.

{
  "data": {
    "manifest": {
      "name": text,
      "repo": url,
      "ver": number
    },
    "files": {
      text: {
        "name": text,
        "url": url,
        "hash": hash    
        "size": filesize, 
        "modified": datetime
      }
    },
    "tags": array
  }

How to query package list

Are you unsure about the package ID for the download you're looking for? This method streamlines the identification process by utilizing keywords within the ID. Furthermore, it will provide you with an array of matching results.

Query packages by keyword

GET https://api.mcjoe21.com/v1/packages/query

Query Parameters

Name
Type
Description

q*

String

The query string to search

tag

Strings List

List of tags to filter results

format

String

Data format of response can be set as

xml

or

json

Here is a demonstration illustrating the output you can expect when a request is sent to the query endpoint. This illustrative example serves to showcase the type of data that will be returned in response to your query.

{
  "data": {
    "results": array
  }
}

Last updated

Was this helpful?