Official Factorio Wiki - User contributions [en]

User:Sevens7

2026-06-17T00:29:55Z

Sevens7: Created page with "I'm here, and staring at http requests against my will"

I'm here, and staring at http requests against my will

Mod portal API

2026-06-16T18:54:41Z

Sevens7: Add default values for optional parameters

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

<code>https://mods.factorio.com/api/mods</code>

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.

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

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

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

List of bookmarked mods can be accessed from following URL (requires authentication).

<code>https://mods.factorio.com/api/bookmarks?username={username}&token={token}</code>

You can also toggle a bookmark using following URL, with <code>state</code> being <code>on</code> or <code>off</code>.

<code>https://mods.factorio.com/api/bookmarks/toggle?username={username}&token={token}&mod={name}&state={state}</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| <code>hide_deprecated</code> || Boolean? || Whether to exclude incompatible mods from the results. Defaults to true if absent
|-
| <code>page</code> || Integer? || Page number to fetch, ignored for <code>page_size="max"</code> queries. Defaults to 1 when absent
|-
| <code>page_size</code> || (Integer <nowiki>|</nowiki> <code>"max"</code>)? || The amount of results to show per page, or all results when passed <code>"max"</code>. Defaults to 25 when absent
|-
| <code>sort</code> || String? (one of <code>"name"</code>, <code>"created_at"</code> or <code>"updated_at"</code>) || Sort results by this property. Defaults to <code>"name"</code> when absent. Ignored for <code>page_size=max</code> queries
|-
| <code>sort_order</code> || String? (either <code>"asc"</code> or <code>"desc"</code>) || Sort results ascending or descending. Defaults to <code>"desc"</code> when absent. Ignored for <code>page_size="max"</code> queries
|-
| <code>namelist</code> || String[]? || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || Mods incompatible with this Factorio version are marked as deprecated and hidden for <code>hide_deprecated=true</code> queries.
|}

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.

=== /api/bookmarks ===

Returns array of mod names

=== /api/search ===
POST Parameters (sent as query parameters):

{| class="wikitable"
! Keys !! Values !! Descrption
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || The version of Factorio to search mods for, mods incompatible with this version are marked as "deprecated"
|-
| <code>lang</code> || Locale Identifier? || No effect on response
|-
| <code>is_space_age</code> || Boolean? || No effect on response
|-
| <code>username</code> || String || factorio.com account username to use for the query
|-
| <code>token</code> || String || factorio.com account token to use for the query
|-
| <code>query</code> || String? || The string to filter by, empty or absent does not filter
|-
| <code>sort_attribute</code> || [[#Sort Attribute|Sort Attribute]]? || The attribute to sort the results by. Defaults to <code>"relevancy"</code> if absent
|-
| <code>only_bookmarks</code> || Boolean? || Whether to filter results down to only mods bookmarked by the account given by <code>username</code> and <code>token</code>. Defaults to false if absent
|-
| <code>show_deprecated</code> || Boolean? || Whether to show mods incompatible with the Factorio version specified with <code>version</code>. Defaults to false if absent
|-
| <code>highlight_pre_tag</code> || String? || A string to place in front of the matched text for <code>query</code>, defaults to <code>"<em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>highlight_post_tag</code> || String? || A string to place behind the matched text for <code>query</code>, defaults to <code>"</em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>expansion</code> || String[]? || A whitelist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>exclude_expansion</code> || String[]? || A blacklist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>category</code> || [[Mod_details_API#Category|Category]][]? || A whitelist of categories to filter mods with
|-
| <code>exclude_category</code> || [[Mod_details_API#Category|Category]][]? || A blacklist of categories to filter mods with
|-
| <code>tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A whitelist of tags to filter mods with
|-
| <code>exclude_tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A blacklist of tags to filter mods with
|-
| <code>page</code> || Integer || Page number you would like to show, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|}

== JSON Object Types ==

=== Sort Attribute ===

{| class="wikitable"
|-
! Attribute !! Sort By
|-
| <code>"relevancy"</code> || Internal metric
|-
| <code>"most_downloads"</code> || Download count
|-
| <code>"last_updated_at"</code> || Most recently updated
|-
| <code>"trending"</code> || Internal metric
|}

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>pagination</code> || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| <code>results</code> || [[#Result Entry|Result]][] || A list of mods, matching the filters specified by the query
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>count</code> || Integer || Total number of mods that match your specified filters.
|-
| <code>links</code> || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| <code>page</code> || Integer || The current page number.
|-
| <code>page_count</code> || Integer || The total number of pages returned.
|-
| <code>page_size</code> || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>first</code> || String(URL) || URL to the first page of the results, or <code>null</code> if you're already on the first page
|-
| <code>prev</code> || String(URL) || URL to the previous page of the results, or <code>null</code> if you're already on the first page
|-
| <code>next</code> || String(URL) || URL to the next page of the results, or <code>null</code> if you're already on the last page
|-
| <code>last</code> || String(URL) || URL to the last page of the results, or <code>null</code> 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.

{| class="wikitable"
! 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
|-
| <code>latest_release</code> || [[#Releases|Release]]? || ✓* || ||
| The latest version of the mod available for download. <b>*Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used</b>.
|-
| <code>downloads_count</code> || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| <code>name</code> || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| <code>owner</code> || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| <code>releases</code> || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. <b>*Only when using <code>namelist</code> [[#/api/mods|parameter]]</b>.
|-
| <code>summary</code> || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| <code>title</code> || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| <code>category</code> || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| <code>score</code> || Integer || ✓ || ✓* || ✓*
| The score of the mod. <b>*Only when not 0</b>.
|-
| <code>thumbnail</code> || 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".
|-
| <code>changelog</code> || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| <code>created_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| <code>updated_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| <code>last_highlighted_at</code> || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| <code>description</code> || String? || || || ✓
| A longer description of the mod, in text only format.
|-
| <code>source_url</code> || String? || || || ✓
| A URL to the mod's source code.
|-
| <code>github_path</code> || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| <code>homepage</code> || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| <code>tags</code> || [[#Mod_details_API#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
|-
| <code>license</code> || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| <code>deprecated</code> || Boolean? || || || ✓
| True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== 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.

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>download_url</code> || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| <code>file_name</code> || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| <code>info_json</code> || 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
|-
| <code>released_at</code> || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| <code>version</code> || String
| The version string of this mod release. Used to determine dependencies.
|-
| <code>sha1</code> || String
| The sha1 key for the file.
|-
| <code>feature_flags</code> || String[]?
| The feature flags this mod uses. See [https://lua-api.factorio.com/latest/types/FeatureFlags.html FeatureFlags]
|-
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>description</code> || String || A short description of the license.
|-
| <code>id</code> || String || The unique id of the license. For more information on each, see [[#Mod_details_API#License|License]]
|-
| <code>name</code> || String || The internal name of the license.
|-
| <code>title</code> || String || The human-readable title of the license.
|-
| <code>url</code> || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type
|-
| <code>message</code> || 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:
<code>https://mods.factorio.com/{download_url}?username={username}&token={token}</code>

[[Category:Technical]]

Mod portal API

2026-06-16T15:12:37Z

Sevens7: typo

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

<code>https://mods.factorio.com/api/mods</code>

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.

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

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

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

List of bookmarked mods can be accessed from following URL (requires authentication).

<code>https://mods.factorio.com/api/bookmarks?username={username}&token={token}</code>

You can also toggle a bookmark using following URL, with <code>state</code> being <code>on</code> or <code>off</code>.

<code>https://mods.factorio.com/api/bookmarks/toggle?username={username}&token={token}&mod={name}&state={state}</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| <code>hide_deprecated</code> || Boolean || Whether to exclude incompatible mods from the results.
|-
| <code>page</code> || Integer || Page number to fetch, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|-
| <code>sort</code> || String? (one of <code>"name"</code>, <code>"created_at"</code> or <code>"updated_at"</code>) || Sort results by this property. Defaults to <code>"name"</code> when absent. Ignored for <code>page_size=max</code> queries
|-
| <code>sort_order</code> || String? (either <code>"asc"</code> or <code>"desc"</code>) || Sort results ascending or descending. Defaults to <code>"desc"</code> when absent. Ignored for <code>page_size="max"</code> queries
|-
| <code>namelist</code> || String[]? || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || Mods incompatible with this Factorio version are marked as deprecated and hidden for <code>hide_deprecated=true</code> queries.
|}

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.

=== /api/bookmarks ===

Returns array of mod names

=== /api/search ===
POST Parameters (sent as query parameters):

{| class="wikitable"
! Keys !! Values !! Descrption
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || The version of Factorio to search mods for, mods incompatible with this version are marked as "deprecated"
|-
| <code>lang</code> || Locale Identifier? || No effect on response
|-
| <code>is_space_age</code> || Boolean? || No effect on response
|-
| <code>username</code> || String || factorio.com account username to use for the query
|-
| <code>token</code> || String || factorio.com account token to use for the query
|-
| <code>query</code> || String? || The string to filter by, empty or absent does not filter
|-
| <code>sort_attribute</code> || [[#Sort Attribute|Sort Attribute]]? || The attribute to sort the results by. Defaults to <code>"relevancy"</code> if absent
|-
| <code>only_bookmarks</code> || Boolean? || Whether to filter results down to only mods bookmarked by the account given by <code>username</code> and <code>token</code>. Defaults to false if absent
|-
| <code>show_deprecated</code> || Boolean? || Whether to show mods incompatible with the Factorio version specified with <code>version</code>. Defaults to false if absent
|-
| <code>highlight_pre_tag</code> || String? || A string to place in front of the matched text for <code>query</code>, defaults to <code>"<em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>highlight_post_tag</code> || String? || A string to place behind the matched text for <code>query</code>, defaults to <code>"</em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>expansion</code> || String[]? || A whitelist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>exclude_expansion</code> || String[]? || A blacklist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>category</code> || [[Mod_details_API#Category|Category]][]? || A whitelist of categories to filter mods with
|-
| <code>exclude_category</code> || [[Mod_details_API#Category|Category]][]? || A blacklist of categories to filter mods with
|-
| <code>tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A whitelist of tags to filter mods with
|-
| <code>exclude_tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A blacklist of tags to filter mods with
|-
| <code>page</code> || Integer || Page number you would like to show, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|}

== JSON Object Types ==

=== Sort Attribute ===

{| class="wikitable"
|-
! Attribute !! Sort By
|-
| <code>"relevancy"</code> || Internal metric
|-
| <code>"most_downloads"</code> || Download count
|-
| <code>"last_updated_at"</code> || Most recently updated
|-
| <code>"trending"</code> || Internal metric
|}

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>pagination</code> || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| <code>results</code> || [[#Result Entry|Result]][] || A list of mods, matching the filters specified by the query
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>count</code> || Integer || Total number of mods that match your specified filters.
|-
| <code>links</code> || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| <code>page</code> || Integer || The current page number.
|-
| <code>page_count</code> || Integer || The total number of pages returned.
|-
| <code>page_size</code> || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>first</code> || String(URL) || URL to the first page of the results, or <code>null</code> if you're already on the first page
|-
| <code>prev</code> || String(URL) || URL to the previous page of the results, or <code>null</code> if you're already on the first page
|-
| <code>next</code> || String(URL) || URL to the next page of the results, or <code>null</code> if you're already on the last page
|-
| <code>last</code> || String(URL) || URL to the last page of the results, or <code>null</code> 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.

{| class="wikitable"
! 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
|-
| <code>latest_release</code> || [[#Releases|Release]]? || ✓* || ||
| The latest version of the mod available for download. <b>*Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used</b>.
|-
| <code>downloads_count</code> || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| <code>name</code> || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| <code>owner</code> || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| <code>releases</code> || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. <b>*Only when using <code>namelist</code> [[#/api/mods|parameter]]</b>.
|-
| <code>summary</code> || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| <code>title</code> || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| <code>category</code> || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| <code>score</code> || Integer || ✓ || ✓* || ✓*
| The score of the mod. <b>*Only when not 0</b>.
|-
| <code>thumbnail</code> || 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".
|-
| <code>changelog</code> || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| <code>created_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| <code>updated_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| <code>last_highlighted_at</code> || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| <code>description</code> || String? || || || ✓
| A longer description of the mod, in text only format.
|-
| <code>source_url</code> || String? || || || ✓
| A URL to the mod's source code.
|-
| <code>github_path</code> || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| <code>homepage</code> || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| <code>tags</code> || [[#Mod_details_API#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
|-
| <code>license</code> || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| <code>deprecated</code> || Boolean? || || || ✓
| True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== 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.

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>download_url</code> || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| <code>file_name</code> || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| <code>info_json</code> || 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
|-
| <code>released_at</code> || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| <code>version</code> || String
| The version string of this mod release. Used to determine dependencies.
|-
| <code>sha1</code> || String
| The sha1 key for the file.
|-
| <code>feature_flags</code> || String[]?
| The feature flags this mod uses. See [https://lua-api.factorio.com/latest/types/FeatureFlags.html FeatureFlags]
|-
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>description</code> || String || A short description of the license.
|-
| <code>id</code> || String || The unique id of the license. For more information on each, see [[#Mod_details_API#License|License]]
|-
| <code>name</code> || String || The internal name of the license.
|-
| <code>title</code> || String || The human-readable title of the license.
|-
| <code>url</code> || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type
|-
| <code>message</code> || 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:
<code>https://mods.factorio.com/{download_url}?username={username}&token={token}</code>

[[Category:Technical]]

Mod portal API

2026-06-16T15:12:15Z

Sevens7: actually show the em tags in the pre and post tags

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

<code>https://mods.factorio.com/api/mods</code>

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.

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

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

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

List of bookmarked mods can be accessed from following URL (requires authentication).

<code>https://mods.factorio.com/api/bookmarks?username={username}&token={token}</code>

You can also toggle a bookmark using following URL, with <code>state</code> being <code>on</code> or <code>off</code>.

<code>https://mods.factorio.com/api/bookmarks/toggle?username={username}&token={token}&mod={name}&state={state}</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| <code>hide_deprecated</code> || Boolean || Whether to exclude incompatible mods from the results.
|-
| <code>page</code> || Integer || Page number to fetch, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|-
| <code>sort</code> || String? (one of <code>"name"</code>, <code>"created_at"</code> or <code>"updated_at"</code>) || Sort results by this property. Defaults to <code>"name"</code> when absent. Ignored for <code>page_size=max</code> queries
|-
| <code>sort_order</code> || String? (either <code>"asc"</code> or <code>"desc"</code>) || Sort results ascending or descending. Defaults to <code>"desc"</code> when absent. Ignored for <code>page_size="max"</code> queries
|-
| <code>namelist</code> || String[]? || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || Mods incompatible with this Factorio version are marked as deprecated and hidden for <code>hide_deprecated=true</code> queries.
|}

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.

=== /api/bookmarks ===

Returns array of mod names

=== /api/search ===
POST Parameters (sent as query parameters):

{| class="wikitable"
! Keys !! Values !! Descrption
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || The version of Factorio to search mods for, mods incompatible with this version are marked as "deprecated"
|-
| <code>lang</code> || Locale Identifier? || No effect on response
|-
| <code>is_space_age</code> || Boolean? || No effect on response
|-
| <code>username</code> || String || factorio.com account username to use for the query
|-
| <code>token</code> || String || factorio.com account token to use for the query
|-
| <code>query</code> || String? || The string to filter by, empty or absent does not filter
|-
| <code>sort_attribute</code> || [[#Sort Attribute|Sort Attribute]]? || The attribute to sort the results by. Defaults to <code>"relevancy"</code> if absent
|-
| <code>only_bookmarks</code> || Boolean? || Whether to filter results down to only mods bookmarked by the account given by <code>username</code> and <code>token</code>. Defaults to false if absent
|-
| <code>show_deprecated</code> || Boolean? || Whether to show mods incompatible with the Factorio version specified with <code>version</code>. Defaults to false if absent
|-
| <code>highlight_pre_tag</code> || String? || A string to place in front of the matched text for <code>query</code>, defaults to <code>"<em&ht;"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>highlight_post_tag</code> || String? || A string to place behind the matched text for <code>query</code>, defaults to <code>"</em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>expansion</code> || String[]? || A whitelist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>exclude_expansion</code> || String[]? || A blacklist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>category</code> || [[Mod_details_API#Category|Category]][]? || A whitelist of categories to filter mods with
|-
| <code>exclude_category</code> || [[Mod_details_API#Category|Category]][]? || A blacklist of categories to filter mods with
|-
| <code>tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A whitelist of tags to filter mods with
|-
| <code>exclude_tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A blacklist of tags to filter mods with
|-
| <code>page</code> || Integer || Page number you would like to show, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|}

== JSON Object Types ==

=== Sort Attribute ===

{| class="wikitable"
|-
! Attribute !! Sort By
|-
| <code>"relevancy"</code> || Internal metric
|-
| <code>"most_downloads"</code> || Download count
|-
| <code>"last_updated_at"</code> || Most recently updated
|-
| <code>"trending"</code> || Internal metric
|}

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>pagination</code> || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| <code>results</code> || [[#Result Entry|Result]][] || A list of mods, matching the filters specified by the query
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>count</code> || Integer || Total number of mods that match your specified filters.
|-
| <code>links</code> || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| <code>page</code> || Integer || The current page number.
|-
| <code>page_count</code> || Integer || The total number of pages returned.
|-
| <code>page_size</code> || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>first</code> || String(URL) || URL to the first page of the results, or <code>null</code> if you're already on the first page
|-
| <code>prev</code> || String(URL) || URL to the previous page of the results, or <code>null</code> if you're already on the first page
|-
| <code>next</code> || String(URL) || URL to the next page of the results, or <code>null</code> if you're already on the last page
|-
| <code>last</code> || String(URL) || URL to the last page of the results, or <code>null</code> 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.

{| class="wikitable"
! 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
|-
| <code>latest_release</code> || [[#Releases|Release]]? || ✓* || ||
| The latest version of the mod available for download. <b>*Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used</b>.
|-
| <code>downloads_count</code> || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| <code>name</code> || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| <code>owner</code> || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| <code>releases</code> || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. <b>*Only when using <code>namelist</code> [[#/api/mods|parameter]]</b>.
|-
| <code>summary</code> || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| <code>title</code> || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| <code>category</code> || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| <code>score</code> || Integer || ✓ || ✓* || ✓*
| The score of the mod. <b>*Only when not 0</b>.
|-
| <code>thumbnail</code> || 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".
|-
| <code>changelog</code> || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| <code>created_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| <code>updated_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| <code>last_highlighted_at</code> || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| <code>description</code> || String? || || || ✓
| A longer description of the mod, in text only format.
|-
| <code>source_url</code> || String? || || || ✓
| A URL to the mod's source code.
|-
| <code>github_path</code> || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| <code>homepage</code> || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| <code>tags</code> || [[#Mod_details_API#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
|-
| <code>license</code> || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| <code>deprecated</code> || Boolean? || || || ✓
| True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== 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.

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>download_url</code> || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| <code>file_name</code> || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| <code>info_json</code> || 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
|-
| <code>released_at</code> || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| <code>version</code> || String
| The version string of this mod release. Used to determine dependencies.
|-
| <code>sha1</code> || String
| The sha1 key for the file.
|-
| <code>feature_flags</code> || String[]?
| The feature flags this mod uses. See [https://lua-api.factorio.com/latest/types/FeatureFlags.html FeatureFlags]
|-
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>description</code> || String || A short description of the license.
|-
| <code>id</code> || String || The unique id of the license. For more information on each, see [[#Mod_details_API#License|License]]
|-
| <code>name</code> || String || The internal name of the license.
|-
| <code>title</code> || String || The human-readable title of the license.
|-
| <code>url</code> || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type
|-
| <code>message</code> || 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:
<code>https://mods.factorio.com/{download_url}?username={username}&token={token}</code>

[[Category:Technical]]

Mod portal API

2026-06-16T14:28:53Z

Sevens7: Add documentation for /api/search endpoint, try to make syntax consistent

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

<code>https://mods.factorio.com/api/mods</code>

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.

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

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

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

List of bookmarked mods can be accessed from following URL (requires authentication).

<code>https://mods.factorio.com/api/bookmarks?username={username}&token={token}</code>

You can also toggle a bookmark using following URL, with <code>state</code> being <code>on</code> or <code>off</code>.

<code>https://mods.factorio.com/api/bookmarks/toggle?username={username}&token={token}&mod={name}&state={state}</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| <code>hide_deprecated</code> || Boolean || Whether to exclude incompatible mods from the results.
|-
| <code>page</code> || Integer || Page number to fetch, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|-
| <code>sort</code> || String? (one of <code>"name"</code>, <code>"created_at"</code> or <code>"updated_at"</code>) || Sort results by this property. Defaults to <code>"name"</code> when absent. Ignored for <code>page_size=max</code> queries
|-
| <code>sort_order</code> || String? (either <code>"asc"</code> or <code>"desc"</code>) || Sort results ascending or descending. Defaults to <code>"desc"</code> when absent. Ignored for <code>page_size="max"</code> queries
|-
| <code>namelist</code> || String[]? || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || Mods incompatible with this Factorio version are marked as deprecated and hidden for <code>hide_deprecated=true</code> queries.
|}

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.

=== /api/bookmarks ===

Returns array of mod names

=== /api/search ===
POST Parameters (sent as query parameters):

{| class="wikitable"
! Keys !! Values !! Descrption
|-
| <code>version</code> || Factorio Version String (e.g. <code>"2.0.76"</code>) || The version of Factorio to search mods for, mods incompatible with this version are marked as "deprecated"
|-
| <code>lang</code> || Locale Identifier? || No effect on response
|-
| <code>is_space_age</code> || Boolean? || No effect on response
|-
| <code>username</code> || String || factorio.com account username to use for the query
|-
| <code>token</code> || String || factorio.com account token to use for the query
|-
| <code>query</code> || String? || The string to filter by, empty or absent does not filter
|-
| <code>sort_attribute</code> || [[#Sort Attribute|Sort Attribute]]? || The attribute to sort the results by. Defaults to <code>"relevancy"</code> if absent
|-
| <code>only_bookmarks</code> || Boolean? || Whether to filter results down to only mods bookmarked by the account given by <code>username</code> and <code>token</code>. Defaults to false if absent
|-
| <code>show_deprecated</code> || Boolean? || Whether to show mods incompatible with the Factorio version specified with <code>version</code>. Defaults to false if absent
|-
| <code>highlight_pre_tag</code> || String? || A string to place in front of the matched text for <code>query</code>, defaults to <code>"<em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>highlight_post_tag</code> || String? || A string to place behind the matched text for <code>query</code>, defaults to <code>"</em>"</code> if absent. If <code>query</code> is empty or absent, value is ignored
|-
| <code>expansion</code> || String[]? || A whitelist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>exclude_expansion</code> || String[]? || A blacklist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)
|-
| <code>category</code> || [[Mod_details_API#Category|Category]][]? || A whitelist of categories to filter mods with
|-
| <code>exclude_category</code> || [[Mod_details_API#Category|Category]][]? || A blacklist of categories to filter mods with
|-
| <code>tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A whitelist of tags to filter mods with
|-
| <code>exclude_tag</code> || [[#Mod_details_API#Tags|Tag]][]? || A blacklist of tags to filter mods with
|-
| <code>page</code> || Integer || Page number you would like to show, ignored for <code>page_size="max"</code> queries
|-
| <code>page_size</code> || Integer or <code>"max"</code> ||The amount of results to show per page, or all results when passed <code>"max"</code>
|}

== JSON Object Types ==

=== Sort Attribute ===

{| class="wikitable"
|-
! Attribute !! Sort By
|-
| <code>"relevancy"</code> || Internal metric
|-
| <code>"most_downloads"</code> || Download count
|-
| <code>"last_updated_at"</code> || Most recently updated
|-
| <code>"trending"</code> || Internal metric
|}

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>pagination</code> || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| <code>results</code> || [[#Result Entry|Result]][] || A list of mods, matching the filters specified by the query
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>count</code> || Integer || Total number of mods that match your specified filters.
|-
| <code>links</code> || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| <code>page</code> || Integer || The current page number.
|-
| <code>page_count</code> || Integer || The total number of pages returned.
|-
| <code>page_size</code> || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>first</code> || String(URL) || URL to the first page of the results, or <code>null</code> if you're already on the first page
|-
| <code>prev</code> || String(URL) || URL to the previous page of the results, or <code>null</code> if you're already on the first page
|-
| <code>next</code> || String(URL) || URL to the next page of the results, or <code>null</code> if you're already on the last page
|-
| <code>last</code> || String(URL) || URL to the last page of the results, or <code>null</code> 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.

{| class="wikitable"
! 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
|-
| <code>latest_release</code> || [[#Releases|Release]]? || ✓* || ||
| The latest version of the mod available for download. <b>*Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used</b>.
|-
| <code>downloads_count</code> || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| <code>name</code> || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| <code>owner</code> || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| <code>releases</code> || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. <b>*Only when using <code>namelist</code> [[#/api/mods|parameter]]</b>.
|-
| <code>summary</code> || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| <code>title</code> || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| <code>category</code> || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| <code>score</code> || Integer || ✓ || ✓* || ✓*
| The score of the mod. <b>*Only when not 0</b>.
|-
| <code>thumbnail</code> || 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".
|-
| <code>changelog</code> || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| <code>created_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| <code>updated_at</code> || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| <code>last_highlighted_at</code> || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| <code>description</code> || String? || || || ✓
| A longer description of the mod, in text only format.
|-
| <code>source_url</code> || String? || || || ✓
| A URL to the mod's source code.
|-
| <code>github_path</code> || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| <code>homepage</code> || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| <code>tags</code> || [[#Mod_details_API#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
|-
| <code>license</code> || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| <code>deprecated</code> || Boolean? || || || ✓
| True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== 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.

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>download_url</code> || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| <code>file_name</code> || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| <code>info_json</code> || 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
|-
| <code>released_at</code> || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| <code>version</code> || String
| The version string of this mod release. Used to determine dependencies.
|-
| <code>sha1</code> || String
| The sha1 key for the file.
|-
| <code>feature_flags</code> || String[]?
| The feature flags this mod uses. See [https://lua-api.factorio.com/latest/types/FeatureFlags.html FeatureFlags]
|-
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| <code>description</code> || String || A short description of the license.
|-
| <code>id</code> || String || The unique id of the license. For more information on each, see [[#Mod_details_API#License|License]]
|-
| <code>name</code> || String || The internal name of the license.
|-
| <code>title</code> || String || The human-readable title of the license.
|-
| <code>url</code> || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type
|-
| <code>message</code> || 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:
<code>https://mods.factorio.com/{download_url}?username={username}&token={token}</code>

[[Category:Technical]]