2017-11-20 widget.mcf.li is now defunct, in favour of cfwidget.com. All embedded widgets continue to work as-is, however, the API has breaking changes. Please point requests to https://api.cfwidget.com. The documentation below has been updated to reflect the new API information. widget.mcf.li will redirect to cfwidget.com for the foreseeable future, however, to ensure no interruption to service please update your usages to (www/api).cfwidget.com.

CurseForge Widget & API

Widgets and API for CurseForge hosted projects. Quick and easy project overview and download information anywhere on the web.

Embeddable CurseForge project widgets for minecraftforum.net and beyond, and a JSON API for consuming CurseForge project information on your website.

Minecraft Forum

Embedding a CurseForge project widget on minecraftforum.net is simple, use the mod, texturepack or world bbcode to place any number of widgets anywhere in your forum topics. Projects are identified by their CurseForge slug or a unique CurseForge project ID.

The optional version parameter accepts a Release Type, Major Version, Major Version with Release Type, or File ID.

Mod

Embed a download widget for the latest version of Mine & Blade: Battlegear 2

[mod]mb-battlegear-2[/mod]

Embed a download widget for version 1.6.4 of Mine & Blade: Battlegear 2

[mod="1.6.4"]mb-battlegear-2[/mod]

Embed a download widget for the latest file with a release type beta of Mine & Blade: Battlegear 2

[mod="beta"]mb-battlegear-2[/mod]

Embed a download widget for the version 1.6.2 beta of Mine & Blade: Battlegear 2

[mod="1.6.2/beta"]mb-battlegear-2[/mod]

Embed a download widget for the #727805 file of Mine & Blade: Battlegear 2

[mod="727805"]mb-battlegear-2[/mod]

Texture Pack

Embed a download widget for the latest version of Equanimity [32x]

[texturepack]equanimity-32x-1-7-x-1-6-x[/texturepack]

Embed a download widget for version 1.7.2 of Equanimity [32x]

[texturepack="1.7.2"]equanimity-32x-1-7-x-1-6-x[/texturepack]

World

Embed a download widget for the latest version of Diversity

[world]diversity[/world]

Embed a download widget for version 1.6.4 of Diversity

[world="1.6.4"]diversity[/world]

Customization

Embed a download widget for the latest version of Lucky Block Spiral

[customization]229041-lucky-block-spiral-1-8-lucky-block-addon[/customization]

Embed a download widget for version 1.8.0 Lucky Block Spiral

[customization="1.8"]229041-lucky-block-spiral-1-8-lucky-block-addon[/customization]

Modpack

Embed a download widget for the latest version of FTB Infinity

[modpack]227724-ftb-infinity[/modpack]

Embed a download widget for latest beta of FTB Infinity

[modpack="beta"]227724-ftb-infinity[/modpack]

Elsewhere

Widgets are embedded using iframes, create an iframe anywhere on your page referencing www.cfwidget.com followed by the curseforge.com identifier for your project. The identifier of your project is the path immediately following curseforge.com, for example, the identifier for curseforge.com/minecraft/mc-mods/mb-battlegear-2 is minecraft/mc-mods/mb-battlegear-2.

<iframe src="https://www.cfwidget.com/mc-mods/minecraft/mb-battlegear-2" width="100%" style="border: none;"></iframe>

Optionally specify the version to be downloaded using the version parameter, by default the latest version will be used.

<iframe src="https://www.cfwidget.com/mc-mods/minecraft/mb-battlegear-2?version=1.6.4" width="100%" style="border: none;"></iframe>

API

Replace www with api in any widget URL and a full JSON representation of all of the data available for the project will be returned, eg: api.cfwidget.com/mc-mods/minecraft/mb-battlegear-2. As with widgets, you may specify a version parameter which will determine which file is returned as the download. For example, api.cfwidget.com/mc-mods/minecraft/mb-battlegear-2?version=1.6.2/beta, will return the latest file of version 1.6.2 with the type beta.

Previously, when the project was ran from widget.mcf.li the data was pulled from curse.com which published different data, therefore, some of the values previously available are no longer available, and some new data is available. For example, you are now able to retrieve all files (including those of alpha type) via the API however you are no longer able to retrieve the number of monthly downloads.

If you have an existing implementation of the API please take the time to explore which data is now available, and update your implementation as appropriate. The breaking changes are the result of an (unexpected) sunset of the previous curse.com website, which this project depended on.

Notes

Project data is scraped from curseforge.com every hour (e.g: at 14:00), each project is updated one by one.

If you are having any problems using the widgets or API please contact citricsquid. Reach via E-mail (sryan@curse.com), or via Private Message on minecraftforum.net .