XenforoResourceManagerAPI

This project aims to safely expose information from the SpigotMC website in a machine-readable format for use in projects and other systems.

Current Capabilities

| Action | Description | |------------------------|------------------------------------------------------------------------------------------------------- | | listResources | get information about all resources in the system |
| getResource | get information about a resource by its ID | | getResourcesByAuthor | get information about all resources created by a specific author by the user id | | listResourceCategories | get information about available resource categories | | getResourceUpdate | get information about a specific resource update by its id | | getResourceUpdates | get information about all of the updates for a specific resource by the resource id | | getAuthor | get information about an author by the user id | | findAuthor | get information about an author by the username (exact username match only) |

How To Use

All requests must currently be sent via GET to https://api.spigotmc.org/simple/0.2/index.php. To get started, attach a GET parameter action specifying which operation you'd like to perform (seen above). Then, attach the action's GET parameter(s). See below for information on the parameters that each action accepts.

Documentation

listResources

Parameters:

| name | type | required | default | description | |---------- |------ |---------- |--------- |----------------------------------------------------------------------------- | | category | int | no | none | The resource category to restrict results to (see listResourceCategories) | | page | int | no | 1 | The page number to retrieve. Items are paginated at 10 results per page. |

Request: https://api.spigotmc.org/simple/0.2/index.php?action=listResources&category=4&page=2

Response (truncated):

[
  {
    "id":"12",
    "title":"BungeeLobbyKick",
    "tag":"This plugin will move all players to a configured server on command",
    "current_version":"0.2",
    "category":{
      "id":3,
      "title":"Bungee - Proxy",
      "description":"Bungee plugins that interact directly with the proxy plugins folder."
    },
    "native_minecraft_version":null,
    "supported_minecraft_versions":null,
    "icon_link":"https:\/\/www.spigotmc.org\/styles\/default\/xenresource\/resource_icon.png",
    "author":{
      "id":"1013",
      "username":"fuzzy_bot"
    },
    "premium":{
      "price":"0.00",
      "currency":""
    },
    "stats":{
      "downloads":"2789",
      "updates":"0",
      "reviews":{
        "unique":"12",
        "total":"12"
      },
      "rating":"4.58333"
    },
    "first_release":1364338800,
    "last_update":1364338800,
    "description":"[B]This plugin will move all players to a configured server when one of these commands is run:[\/B]\n\n[B]\/lobbykick (Kick all players to lobby)[\/B]\n[B]\/lobbykickstop (lobbykick + Runs console command stop)[\/B]\n[B]\/lobbykickrestart ([\/B][B]lobbykick +[\/B][B]Runs console command restart <- this is a spigot feature)[\/B]\n\n\n[B]All of the above commands require the permission \"Lobby.Kick\" or may be run from the console.[\/B]\n\n[B]\/lobbykickplayer playername (kick 1 player, Requires Lobby.Kick.Player permission)[\/B]\n\n[B]The server name to move the players to is in the \"config.yml\" file in the BungeeLobbyKick folder. The default is to move players to the server \"lobby\". You can reload this file using:[\/B]\n\n[B]\/lobbykickreload (rereads config file)[\/B]",
    "source_code_url":"",
    "donate_url":""
  },
  {
    "id":"13",
    "title":"BungeeKickStop",
    "tag":"Bungee Kick control plugin - move players to a different server when kicked",
    "current_version":"0.1",
    "category":{
      "id":3,
      "title":"Bungee - Proxy",
      "description":"Bungee plugins that interact directly with the proxy plugins folder."
    },      
    "native_minecraft_version":null,
    "supported_minecraft_versions":null,
    "icon_link":"https:\/\/www.spigotmc.org\/styles\/default\/xenresource\/resource_icon.png",
    "author":{
      "id":"1013",
      "username":"fuzzy_bot"
    },
    "premium":{
      "price":"0.00",
      "currency":""
    },
    "stats":{
      "downloads":"1776",
      "updates":"0",
      "reviews":{
        "unique":"3",
        "total":"3"
      },
      "rating":"5"
    },
    "first_release":1364338800,
    "last_update":1364338800,
    "description":"BungeeKickStop moves players to a configured server when the player is kicked with a specific message.\n \nConfiguration is in the config.txt file. An empty file is generated the first time you start the plugin.\n \ncreate lines in config.txt to setup the kick filters:\n \nservername!!!Kick Text!!!Message &dto &fuser\n \nWhen a player is kicked the kick is evaluated for \"Kick Text\"\nif this is found, the player is sent to \"servername\" server and also told \"Message &dto &fuser\"\n \nwith permission bks.reload use the command \/bksreload to reload the configuration\n \n \n** Note ** This requires the latest version of Bungee!",
    "source_code_url":"",
    "donate_url":""
  }
]

getResource

Parameters:

| name | type | required | default | description | |------ |------ |---------- |--------- |------------------------------------------------ | | id | int | yes | none | The id of the resource to retrieve |

Request: https://api.spigotmc.org/simple/0.2/index.php?action=getResource&id=2

Response:

{
  "id":"2",
  "title":"HubKick",
  "tag":"Send players to lobby on kick. \/lobby \/ hub",
  "current_version":"1.7.1",
  "category":{
    "id":2,
    "title":"Bungee - Spigot",
    "description":"Spigot plugins that interact with BungeeCord."
  },    
  "native_minecraft_version":null,
  "supported_minecraft_versions":[
    "1.7",
    "1.8",
    "1.9"
  ],
  "icon_link":"https:\/\/www.spigotmc.org\/data\/resource_icons\/0\/2.jpg?1482076430",
  "author":{
    "id":"106",
    "username":"LaxWasHere"
  },
  "premium":{
    "price":"0.00",
    "currency":""
  },
  "stats":{
    "downloads":"7719",
    "updates":"22",
    "reviews":{
      "unique":"11",
      "total":"11"
    },
    "rating":"5"
  },
  "first_release":1364338800,
  "last_update":1515884400,
  "description":"[CENTER][I][B][URL='https:\/\/discord.gg\/SvFEBGW'][IMG]https:\/\/i.imgur.com\/inmwaK3.png[\/IMG] [\/URL]| [URL='https:\/\/www.paypal.me\/LaxWasHere'][IMG]https:\/\/i.imgur.com\/h5YgdLC.png[\/IMG][\/URL] | [URL='https:\/\/github.com\/AwesomePowered\/HubKick'][IMG]https:\/\/i.imgur.com\/ikjLwXh.png[\/IMG][\/URL][\/B][\/I][\/CENTER]\n[I][B]Info[\/B]\nWhen a player get's kicked from the server, this plugin will forward him\/her to the server you specified in the config.yml.\nKick everyone and shutdown the server or just kick everyone.\n\n[B]Configuration[\/B]\n[code]#Hub is the server you want the players to be sent to.\nHubServer: hub\n\n#Enable this and it will pick a hub on random when kicked\nHubs:\n- Hub\n- Lobby\nrandomHubs: false\n\n#Regex pattern for forcekicking a player. No touchy touchy pls\nignorePattern: '(\\bafk|AFK|-f\\b)'\n\n#Prefix\nprefix: '&4[&aHubKick&4]'\n\n#Message to be sent when kicking everyone\/ shutting down the server.\nKickallMessage: '&a&lServer shutting down, you have been kicked to the hub!'\n\n#Should the plugin send the users on hub on kick?\nHubOnKick: true\n[\/code]\n\n[B]Installation[\/B]\n [\/I]\n[LIST]\n[I]\n[LIST][*]Drop the HubKick.jar at your \/plugins folder[\/LIST]\n[LIST][*]Restart Server[\/LIST]\n[LIST][*]Get Kicked[\/LIST][\/I]\n[\/LIST]\n[I][B]Commands:[\/B]\n[CODE]\/hub (sends you to he hub server)\n\/lobby (same as above)\n\/alltolobby (sends everyone to lobby)\n\/lobbyall (Same as above)\n\/sendplayer(Sends player to a server)\n\/sendp(^)\n\/shutdown (sends everyone to lobby and shuts down the server)\n\/forcekick (kicked the player off the network) (or simply add -f to a kick message)\n\/fkick (same as above)\n[\/CODE]\n\n[B]Permissions:[\/B]\n [\/I]\n[LIST]\n[I]\n[LIST][*]hubkick.command[\/LIST]\n[LIST][*]hubkick.kickall[\/LIST]\n[LIST][*]hubkick.send[\/LIST]\n[LIST][*]hubkick.shutdown[\/LIST]\n[LIST][*]hubkick.forcekick[\/LIST][\/I]\n[\/LIST]\n[I][URL='https:\/\/github.com\/AwesomePowered\/HubKick']Github[\/URL][\/I]",
  "source_code_url":"",
  "donate_url":""
}

getResourcesByAuthor

Parameters:

| name | type | required | default | description | |------ |------ |---------- |--------- |----------------------------------------------------------------------------- | | id | int | yes | none | The id of the author to restrict results to (see findAuthor) | | page | int | no | 1 | The page number to retrieve. Items are paginated at 10 results per page. |

Request: https://api.spigotmc.org/simple/0.2/index.php?action=getResourcesByAuthor&id=100356&&page=1

Response (truncated):

[
  {
    "id":"57242",
    "title":"spark",
    "tag":"spark is a performance profiling plugin\/mod for Minecraft clients, servers and proxies.",
    "current_version":"1.6.1", 
    "category":{
      "i

XenforoResourceManagerAPI

Install / Use

README