Mod portal API: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Removed {{Languages}})
 
(63 intermediate revisions by 13 users not shown)
Line 1: Line 1:
<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>
The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ 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.
The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ 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.


Line 7: Line 9:
<code>https://mods.factorio.com/api/mods/{name}</code>
<code>https://mods.factorio.com/api/mods/{name}</code>


== Object Types ==
To get even more information about a mod, you can use the following URL.
 
<code>https://mods.factorio.com/api/mods/{name}/full</code>
 
== Endpoints ==


=== Result Entry ===
=== /api/mods ===


Fields returned by the api/mods endpoint are marked with a check (✓) in the "Short" column, and those returned the the api/mods/{name} endpoint are marked with a check in the "Full" column.
GET Parameters (sent as query parameters):


{| class="wikitable"
{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
! Key !! Values !! Description
|-
|-
| created_at || String(ISO 8601) || ✓ || ✓
| hide_deprecated || {boolean} || Only return non-deprecated mods.  
| The datetime the mod was uploaded, in the full ISO 8601 format, with a space separator instead of 'T'.
|-
|-
| current_user_rating || Null || ✓ || ✓
| 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
| Doesn't seem to be implemented yet.
|-
|-
| description || String || || ✓
| page_size ||{an integer or 'max'}||The amount of results to show in your search
| A longer description of the mod, in text only format.
|-
|-
| description_html || String(HTML) || || ✓
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
| A longer description of the mod, with HTML tags.
|-
|-
| downloads_count || Integer || ✓ || ✓
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
| Number of downloads.
|-
|-
| first_media_file || Object || ✓ ||
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
| The first media file in the "media_files" list.
|-
|-
| game_versions || String[] || ✓ || ✓
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version
| A list of major Factorio version strings (e.g. "0.13") starting with 0.13 that the mod is compatible with, ''in addition to'' the version(s) found in "latest_release" / "releases".  
|}
 
 
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 ===
 
{| class="wikitable"
! Key !! Type !! Description
|-
|-
| github_path || String || ✓ || ✓
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
|-
| homepage || String || ✓ || ✓
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
| Usually a URL to the mod's main project page, but can be any string.
|}
 
=== Pagination ===
 
{| class="wikitable"
! Key !! Type !! Description
|-
|-
| id || Integer || ✓ || ✓
| count || Integer || Total number of mods that match your specified filters.
| A numerical mod ID used to identify the mod in other API endpoints.
|-
|-
| latest_release || Object || ✓ ||  
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
| The latest version of the mod available for download. See [[#Releases]]
|-
|-
| license_flags || Integer(11 bit) || ✓ || ✓
| page || Integer || The current page number.
| A bit field describing what permissions the mod's license grants. See [[#License Flags]]
|-
|-
| license_name || String || ✓ || ✓
| page_count || Integer || The total number of pages returned.
| The mod's license name.
|-
|-
| license_url || String || ✓ || ✓
| page_size || Integer || The number of results per page.
| A URL link to the full license agreement. Can be any string in case of custom licenses.
|}
 
=== Pagination Links ===
 
{| class="wikitable"
! Key !! Type !! Description
|-
|-
| media_files || Object[] || || ✓
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
| A list of media files, such as screen shots of the mod in action. See [[#Media Files]].
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
|-
| name || String || ✓ || ✓
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
| The mod's machine-readable ID string.
|-
|-
| owner || String || ✓ || ✓
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
| The Factorio username of the mod's author.
|-
| ratings_count || 0 || ✓ || ✓
| Doesn't seem to be implemented yet.
|-
| releases || Object[] || || ✓
| A list of different versions of the mod available for download. See [[#Releases]]
|-
| summary || String || ✓ || ✓
| A shorter mod description.
|-
| tags || Object[] || ✓ || ✓
| A list of tag objects that categorize the mod.
|-
| title || String || ✓ || ✓
| The mod's human-readable name.
|-
| updated_at || String(ISO 8601) || ✓ || ✓
| The datetime the mod was last updated, in the full ISO 8601 format, with a space separator instead of 'T'.
|-
| visits_count || Integer || ✓ || ✓
| The number of times the mod was viewed, but perhaps only counted on the web interface???
|}
|}


=== License Flags ===
=== Result Entry ===


The "license_flags" is an 11 bit number that describe generally what permissions the mod's license grants.
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. Fields may be absent if there is no data.


{| class="wikitable"
{| class="wikitable"
! 2<sup>n</sup> !! Title !! Description
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
|-
! colspan=3 | Permissions
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
|-
| 0 || Commercial Use || This software and derivatives may be used for commercial purposes
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
|-
| 1 || Modification || The software may be modified.
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
|-
| 2 || Distribution || You may distribute this software.
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
|-
| 3 || Patent Use || This license provides an express grant of patent rights from the contributor to the recipient.
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
|-
| 4 || Private Use || You may use and modify the software without distributing it.
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
|-
! colspan=3 | Conditions
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
|-
| 5 || Disclose Source || Source code must be made available when distributing the software.
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].
|-
|-
| 6 || License & Copyright Notice || Include a copy of the license and copyright notice with the code.
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
|-
| 7 || Same License || Modifications must be released under the same license when distributing the software. In some cases a similar or related license may be used.
| changelog || String || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created.
|-
|-
| 8 || State Changes || Indicate changes made to the code.
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
|-
! colspan=3 | Limitations
| source_url || String || || || ✓
| A URL to the mod's source code.
|-
|-
| 9 || Hold Liable || Software is provided without warranty and the software author/license owner cannot be held liable for damages.
| github_path || String || || || ✓
| Deprecated: Use <code>source_url</code> instead. 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.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
|-
| 10 || Trademark Use || This license explicitly states that it does NOT grant you trademark rights, even though licenses without such a statement probably do not grant you any implicit trademark rights.
|}
|}


=== Media File ===
=== Releases ===


A media file object describes a single image, along with a smaller thumbnail sized version of the image.
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.


{| class="wikitable"
{| class="wikitable"
! Key !! Type !! Description
! Key !! Type !! Description
|-
|-
| id || Integer || Some sort of numerical id of unknown purpose.
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
|-
| width || Integer || Width of the full sized image in pixels.
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
|-
| height || Integer || Height of the full sized image in pixels.
| 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 8601 for when the mod was released.
|-
|-
| size || Integer || Size of the full image in bytes.
| version || String
| The version string of this mod release. Used to determine dependencies.  
|-
|-
| urls || Object || URLs to the full sized image and a thumbnail, see below.
| sha1 || String
| The sha1 key for the file
|-
|}
|}


The "urls" object contains two keys: "original" that links to the original, full sized image, and "thumb" that links to a 144x144 pixel PNG image. The original image is in either PNG, JPEG, or GIF formats, with the extensions ".png", ".jpg", or ".gif". All image URLs seem to be located at https://mods-data.factorio.com/pub_data/media_files/ with a file name consisting of 12 alphanumerical characters (of the base64 alphabet) followed by the file extension. The thumbnail URL contains the same code, but instead with a file extension of ".thumb.png".
=== Tags ===


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


{| class="wikitable"
{| class="wikitable"
! Key !! Type !! Description
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
|-
| download_url || String ||
| 18 || t || armor || Armor || Armors or armor equipment.
|-
|-
| downloads_count || Integer ||
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
|-
| factorio_version || String ||
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
|-
| file_name || String ||
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
|-
| file_size || Integer ||
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
|-
| game_version || String ||
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
|-
| id || Integer ||
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
|-
| info_json || Object ||
| 25 || t || cheats || Cheats || Play it your way.
|-  
|-  
| released_at || String(ISO 8601) ||  
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
|-
| version || String ||
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}
|}
=== License ===
{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}
=== Error ===
{| class="wikitable"
! Key !! Type !! Description
|-
| message || 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 | Web Authentication API]].
Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}




{{Languages}}[[Category:Technical]]
[[Category:Technical]]

Latest revision as of 09:07, 12 November 2023

Category: Internal API

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}

To get even more information about a mod, you can use the following URL.

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

Endpoints

/api/mods

GET Parameters (sent as query parameters):

Key Values Description
hide_deprecated {boolean} Only return non-deprecated mods.
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
sort {enum, one of name, created_at or updated_at} Sort results by this property. Defaults to name when not defined. Ignored for page_size=max queries.
sort_order {enum, one of asc or desc} Sort results ascending or descending. Defaults to descending when not defined. Ignored for page_size=max queries.
namelist {array of strings} Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include releases instead of latest_release.
version {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} Only return non-deprecated mods compatible with this Factorio version


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. Fields may be absent if there is no data.

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. Absent when the namelist parameter is used.
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. *Only when using namelist parameter.
summary String ✓ ✓ ✓ A shorter mod description.
title String ✓ ✓ ✓ The mod's human-readable name.
category Category? ✓ ✓ ✓ A single category describing the mod. See Mod_details_API#Category.
thumbnail String(relative URL) ✓ ✓ The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to "/assets/.thumb.png". Prepend "assets-mod.factorio.com".
changelog String ✓ A string describing the recent changes to a mod.
created_at String(ISO 8601) ✓ ISO 8601 for when the mod was created.
description String ✓ A longer description of the mod, in text only format.
source_url String ✓ A URL to the mod's source code.
github_path String ✓ Deprecated: Use source_url instead. 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.
tags Tag[] ✓ A list of tag names that categorize the mod. See #Tags.
license #License[] ✓ The license that applies to the mod. See #License.

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 8601 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

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

id type name title description
12 t transportation Transportation Transportation of the player, be it vehicles or teleporters.
13 t logistics Logistics Augmented or new ways of transporting materials - belts, inserters, pipes!
?? t combat Combat New ways to deal with enemies, be it attack or defense.
17 t enemies Enemies Changes to enemies or entirely new enemies to deal with.
18 t armor Armor Armors or armor equipment.
?? t environment Environment Map generation and terrain modification.
20 t logistic-network Logistics Network Related to roboports and logistic robots
?? t circuit-network Circuit network Entities which interact with the circuit network.
21 t storage Storage More than just chests.
22 t power Power Production Changes to power production and distribution.
23 t manufacturing Manufacture Furnaces, assembling machines, production chains
24 t blueprints Blueprints Change blueprint behavior.
25 t cheats Cheats Play it your way.
27 t mining Mining New ores and resources as well as machines.
?? t fluids Fluids Things related to oil and other fluids.
29 t trains Trains Trains are great, but what if they could do even more?

License

Key Type Description
description String A short description of the license.
id String The unique id of the license.
name String The internal name of the license.
title String The human-readable title of the license.
url String Usually a URL to the full license text, but can be any string.

Error

Key Type Description
message 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/{download_url}?username={username}&token={token}

Retrieved from "https://wiki.factorio.com/index.php?title=Mod_portal_API&oldid=195197"