Mod portal API

	This article is a stub, and not comprehensive.
	You can help this wiki by expanding it.

The Mod Portal API is used to both browse and download all mods available on the official Factorio mod portal. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

https://mods.factorio.com/api/mods

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

https://mods.factorio.com/api/mods/{name}

Endpoints

TODO!!! Note: The mod portal has been partially rewritten, and much of this section is out of date. Most of the parameters have been shifted to url path strings. Documentation needs to be updated, I'll do it soon(tm)! --Lexxy Fox (talk) 15:44, 24 February 2018 (UTC)

/api/mods

GET Parameters:

Key	Values	Description
page	{an integer}	Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
page_size	{an integer or 'max'}	The amount of results to show in your search
namelist	{array of strings}	Return only mods that match the given names.

Returns #Mod List Response

/api/mods/{mod_name}

Return short information of a specific mod.

See #Result Entry, "Short" column.

/api/mods/{mod_name}/full

Returns more information of a mod.

See #Result Entry, "Full" column.

JSON Object Types

Mod List Response

Key	Type	Description
pagination	Pagination	See #Pagination
results	Result[]	A list of mods, matching any filters you specified.

Pagination

Key	Type	Description
count	Integer	Total number of mods that match your specified filters.
links	Links	Utility links to mod portal api requests, preserving all filters and search queries.
page	Integer	The current page number.
page_count	Integer	The total number of pages returned.
page_size	Integer	The number of results per page.

Pagination Links

Key	Type	Description
first	String(URL)	URL to the first page of the results, or null if you're already on the first page.
prev	String(URL)	URL to the previous page of the results, or null if you're already on the first page.
next	String(URL)	URL to the next page of the results, or null if you're already on the last page.
last	String(URL)	URL to the last page of the results, or null if you're already on the last page.

Result Entry

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column.

Key	Type	api/mods endpoint	Short	Full	Description
downloads_count	Integer	✓	✓	✓	Number of downloads.
latest_release	Release	✓			The latest version of the mod available for download. See #Releases
name	String	✓	✓	✓	The mod's machine-readable ID string.
owner	String	✓	✓	✓	The Factorio username of the mod's author.
releases	Release[]		✓	✓	A list of different versions of the mod available for download. See #Releases
summary	String	✓	✓	✓	A shorter mod description.
title	String	✓	✓	✓	The mod's human-readable name.
changelog	String			✓	A string describing the recent changes to a mod
created_at	String(ISO 8601)			✓	ISO 6501 for when the mod was created.
description	String			✓	A longer description of the mod, in text only format.
github_path	String			✓	A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
homepage	String			✓	Usually a URL to the mod's main project page, but can be any string.
tag	Tag[]			✓	A list of tag objects that categorize the mod. See #Tags.

Releases

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

Key	Type	Description
download_url	String	Path to download for a mod. starts with "/download" and does not include a full url. See #Downloading Mods
file_name	String	The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
info_json	Object	A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
released_at	String(ISO 8601)	ISO 6501 for when the mod was released.
version	String	The version string of this mod release. Used to determine dependencies.
sha1	String	The sha1 key for the file

Tags

Key	Type	Description
id	Integer	A numerical ID unique to this tag.
name	String	An all lower-case string used to identify this tag internally.
title	String	The tag's human-readable tag name.
description	String	A short description for the tag.
type	String

Currently, there are only a fixed number of tags available, these include:

id	type	name	title	description
1	t	general	General	Mods that cannot be sorted into other categories
2	t	non-game-changing	Non-Game-Changing	Changes only look&feel. New graphics, new sounds, ... such things.
3	t	helper-mods	Helper Mods	These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...
6	t	big-mods	Big Mods	Too big and/or changes too much of the game to be fit anywhere else
12	t	transportation	Transportation	Player transport
13	t	logistics	Logistics	Transport of materials
14	t	utility	Utility	Helps with certain things the player is doing.
15	t	balancing	Balancing	Makes the game much more fair
17	t	enemies	Enemies	Adds more enemies for more challange
16	t	weapons	Weapons	Adds more weapons to annihilate the enemy
18	t	armor	Armor	Armors or armor equipment related.
19	t	oil	Oil	Things related to oil related manufacture
20	t	logistics-network	Logistics Network	Related to roboports and logistic robots
21	t	storage	Storage	Allows more ways to be able to store items
22	t	power-production	Power Production	Allows more ways to create mass amounts of energy
23	t	manufacture	Manufacture	Furnaces, assembling machines, production chains
24	t	blueprints	Blueprints
25	t	cheats	Cheats	Well, they let you cheat
26	t	defense	Defense	Mods that add the ability to protect your base more
27	t	mining	Mining	Mods that provide better or new ways of mining resources
28	t	info	Info	Mods that provide additional information to the player
29	t	trains	Trains	Related to trains

Error

Key	Type	Description
detail	String

Downloading Mods

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see Application_directory#User_data_directory). You can also get the token by using the Web Authentication API.

Example usage: https://mods.factorio.com/api/{download_url}?username={username}&token={token}