Documentation

GET /api/project/:id

View all information of a project. Timestamps (date_added, date_updated, date_release) are UNIX timestamps in milliseconds. The target_file is the file after installation that should be run to run the project. Most fields can be null, because it is not yet complete or because it is a library or other type of project that cannot be installed etc. The description has three variants, all of which are optional. Try to use which is best in your use case and try to use the others as fallbacks (e.g. description_short with a truncated version of the default description as fallback). Keywords and tags are both a list of items seperated by a comma, which are not trailed by a space. Download_recent shows the number of downloads in the last 30 days.

URL Params

Example of returned JSON

{
	"success": true,
	"project": {
		"id": 1,
		"date_added": 1694617285452,
		"date_updated": 0,
		"date_release": 0,
		"date_publish": 1694617285452,
		"owner_discord": "302427405023313920",
		"owner_name": "Xella",
		"name": "CCDoom",
		"install_command": "pastebin run xLC8mABU",
		"download_url": null,
		"target_file": "Doom.lua",
		"tags": [
			"fun",
			"action"
		],
		"repository": "https://github.com/Xella37/CCDoom",
		"description_short": "CCDoom is a 3d first-person shooter in ComputerCraft made using the Pine3D graphics library. It is inspired by the game \"Doom\" as the name implies.",
		"description": "CCDoom is a 3d first-person shooter ... truncated for example",
		"description_markdown": "CCDoom is a 3d first-person shooter ... truncated for example",
		"has_thumbnail": true,
		"hide_thumbnail": false,
		"media_count": 5,
		"keywords": [
			"pine",
			"pine3d",
			"3d",
			"shooter",
			"doom",
			"graphics",
			"first",
			"person"
		],
		"downloads": 22,
		"downloads_recent": 20,
		"views": 58,
		"views_recent": 50,
		"likes": 3,
		"visible": true
	}
}