Mod portal API - Revision history

Sevens7: /* Result Entry */ latest_release does not appear as a Release object in the search api response

2026-07-28T18:44:49Z

Result Entry: latest_release does not appear as a Release object in the search api response

← Older revision		Revision as of 18:44, 28 July 2026
Line 173:		Line 173:
	! 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 !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' \| api/search !! 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 !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' \| api/search !! Description
	\|-		\|-
	\| <code>latest_release</code> \|\| [[#Releases\|Release]]? \|\| ✓* \|\| \|\| \|\| ✓		\| <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>.		\| The latest version of the mod available for download. <b>*Absent when the <code>namelist</code> [[#/api/mods\|parameter]] is used</b>.
	\|-		\|-

Sevens7: /* Result Entry */ Add new fields, and mark what fields are present in search api response

2026-07-28T18:39:09Z

Result Entry: Add new fields, and mark what fields are present in search api response

Sevens7: correct links

2026-07-23T20:02:20Z

correct links

← Older revision		Revision as of 20:02, 23 July 2026
Line 100:		Line 100:
	\| <code>exclude_category</code> \|\| [[Mod_details_API#Category\|Category]][]? \|\| A blacklist 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>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>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</code> \|\| Integer \|\| Page number you would like to show, ignored for <code>page_size="max"</code> queries
Line 228:		Line 228:
	\| Usually a URL to the mod's main project page, but can be any string.		\| Usually a URL to the mod's main project page, but can be any string.
	\|-		\|-
	\| <code>tags</code> \|\| [[#Mod_details_API#Tags\|Tag]][] \|\| \|\| \|\| ✓		\| <code>tags</code> \|\| [[Mod_details_API#Tags\|Tag]][] \|\| \|\| \|\| ✓
	\| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].		\| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
	\|-		\|-

Sevens7: Mention that relevancy seems to be identical to recently updated

2026-06-19T21:30:48Z

Mention that relevancy seems to be identical to recently updated

← Older revision		Revision as of 21:30, 19 June 2026
Line 117:		Line 117:
	! Attribute !! Sort By		! Attribute !! Sort By
	\|-		\|-
	\| <code>"relevancy"</code> \|\| ~~Internal metric~~		\| <code>"relevancy"</code> \|\| Seemingly identical to <code>"last_updated_at"</code>
	\|-		\|-
	\| <code>"most_downloads"</code> \|\| Download count		\| <code>"most_downloads"</code> \|\| Download count

Sevens7: json content, not query params

2026-06-19T17:58:41Z

json content, not query params

← Older revision		Revision as of 17:58, 19 June 2026
Line 65:		Line 65:

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

	{\| class="wikitable"		{\| class="wikitable"

Sevens7: Note that the pagination links aren't present in the search endpoint response

2026-06-18T21:14:29Z

Note that the pagination links aren't present in the search endpoint response

← Older revision		Revision as of 21:14, 18 June 2026
Line 143:		Line 143:
	\| <code>count</code> \|\| Integer \|\| Total number of mods that match your specified filters.		\| <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>links</code> \|\| [[#Pagination_Links\|Links]]? \|\| Utility links to mod portal api requests, preserving all filters and search queries. Absent from the <code>/api/search</code> endpoint response
	\|-		\|-
	\| <code>page</code> \|\| Integer \|\| The current page number.		\| <code>page</code> \|\| Integer \|\| The current page number.

Sevens7: Add default values for optional parameters

2026-06-16T18:54:41Z

Add default values for optional parameters

← Older revision		Revision as of 18:54, 16 June 2026
Line 30:		Line 30:
	! Key !! Values !! Description		! Key !! Values !! Description
	\|-		\|-
	\| <code>hide_deprecated</code> \|\| Boolean \|\| Whether to exclude incompatible mods from the results.		\| <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		\| <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 or <code>"max"</code> \|\|The amount of results to show per page, or all results when passed <code>"max"</code>		\| <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</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

Sevens7: typo

2026-06-16T15:12:37Z

typo

← Older revision		Revision as of 15:12, 16 June 2026
Line 88:		Line 88:
	\| <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>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_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>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

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

2026-06-16T15:12:15Z

actually show the em tags in the pre and post tags

← Older revision		Revision as of 15:12, 16 June 2026
Line 88:		Line 88:
	\| <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>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_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>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>expansion</code> \|\| String[]? \|\| A whitelist of expansion(s) to filter mods with (currently the only valid value is <code>"space-age"</code>)

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

2026-06-16T14:28:53Z

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

Show changes

← Older revision		Revision as of 18:39, 28 July 2026
Line 171:		Line 171:

	{\| class="wikitable"		{\| 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		! 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 !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' \| api/search !! Description
	\|-		\|-
	\| <code>latest_release</code> \|\| [[#Releases\|Release]]? \|\| ✓* \|\| \|\|		\| <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>.		\| 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 \|\| ✓ \|\| ✓ \|\| ✓		\| <code>downloads_count</code> \|\| Integer \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| Number of downloads.		\| Number of downloads.
	\|-		\|-
	\| <code>name</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓		\| <code>name</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| The mod's machine-readable ID string.		\| The mod's machine-readable ID string.
	\|-		\|-
	\| <code>owner</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓		\| <code>owner</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| The Factorio username of the mod's author.		\| The Factorio username of the mod's author.
	\|-		\|-
	\| <code>releases</code> \|\| [[#Releases\|Release]][] \|\| ✓* \|\| ✓ \|\| ✓		\| <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>.		\| 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 \|\| ✓ \|\| ✓ \|\| ✓		\| <code>summary</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| A shorter mod description.		\| A shorter mod description.
	\|-		\|-
	\| <code>title</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓		\| <code>title</code> \|\| String \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| The mod's human-readable name.		\| The mod's human-readable name.
	\|-		\|-
	\| <code>category</code> \|\| [[Mod_details_API#Category\|Category]]? \|\| ✓ \|\| ✓ \|\| ✓		\| <code>category</code> \|\| [[Mod_details_API#Category\|Category]]? \|\| ✓ \|\| ✓ \|\| ✓ \|\| ✓
	\| A single category describing the mod. See [[Mod_details_API#Category]].		\| A single category describing the mod. See [[Mod_details_API#Category]].

	\|-		\|-
	\| <code>score</code> \|\| Integer \|\| ✓ \|\| ✓* \|\| ✓*		\| <code>score</code> \|\| Integer \|\| ✓ \|\| ✓* \|\| ✓* \|\|
	\| The score of the mod. <b>*Only when not 0</b>.		\| The score of the mod. <b>*Only when not 0</b>.
	\|-		\|-
	\| <code>thumbnail</code> \|\| String(relative URL)? \|\| \|\| ✓ \|\| ✓		\| <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".		\| 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? \|\| \|\| \|\| ✓		\| <code>changelog</code> \|\| String? \|\| \|\| \|\| ✓ \|\|
	\| A string describing the recent changes to a mod.		\| A string describing the recent changes to a mod.
	\|-		\|-
	\| <code>created_at</code> \|\| String(ISO 8601) \|\| \|\| \|\| ✓		\| <code>created_at</code> \|\| String(ISO 8601) \|\| \|\| \|\| ✓ \|\| ✓
	\| ISO 8601 for when the mod was created. (RFC 3339 nano)		\| ISO 8601 for when the mod was created. (RFC 3339 nano)
	\|-		\|-
	\| <code>updated_at</code> \|\| String(ISO 8601) \|\| \|\| \|\| ✓		\| <code>updated_at</code> \|\| String(ISO 8601) \|\| \|\| \|\| ✓ \|\| ✓
	\| ISO 8601 for when the mod was last updated. (RFC 3339 nano)		\| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
	\|-		\|-
	\| <code>last_highlighted_at</code> \|\| String(ISO 8601)? \|\| \|\| \|\| ✓		\| <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)		\| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
	\|-		\|-
	\| <code>description</code> \|\| String? \|\| \|\| \|\| ✓		\| <code>description</code> \|\| String? \|\| \|\| \|\| ✓ \|\|
	\| A longer description of the mod, in text only format.		\| A longer description of the mod, in text only format.
	\|-		\|-
	\| <code>source_url</code> \|\| String? \|\| \|\| \|\| ✓		\| <code>source_url</code> \|\| String? \|\| \|\| \|\| ✓ \|\| ✓
	\| A URL to the mod's source code.		\| A URL to the mod's source code.
	\|-		\|-
	\| <code>github_path</code> \|\| String? \|\| \|\| \|\| ✓		\| <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 ("").		\| 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 \|\| \|\| \|\| ✓		\| <code>homepage</code> \|\| String \|\| \|\| \|\| ✓ \|\|
	\| Usually a URL to the mod's main project page, but can be any string.		\| Usually a URL to the mod's main project page, but can be any string.
	\|-		\|-
	\| <code>tags</code> \|\| [[Mod_details_API#Tags\|Tag]][] \|\| \|\| \|\| ✓		\| <code>tags</code> \|\| [[Mod_details_API#Tags\|Tag]][] \|\| \|\| \|\| ✓ \|\| ✓
	\| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].		\| A list of tag names that categorize the mod. See [[#Mod_details_API#Tags]].
	\|-		\|-
	\| <code>license</code> \|\| [[#License]][] \|\| \|\| \|\| ✓		\| <code>license</code> \|\| [[#License]][] \|\| \|\| \|\| ✓ \|\|
	\| The license that applies to the mod. See [[#License]].		\| The license that applies to the mod. See [[#License]].
	\|-		\|-
	\| <code>deprecated</code> \|\| Boolean? \|\| \|\| \|\| ✓		\| <code>deprecated</code> \|\| Boolean \|\| \|\| \|\| ✓ \|\| ✓
	\| True if the mod is marked as deprecated by its owner~~. Absent when false~~.		\| True if the mod is marked as deprecated by its owner.
	\|-		\|-
			\| <code>requires_space_age</code> \|\| Boolean \|\| ? \|\| ? \|\| ? \|\| ✓
			\| True if the mod depends on the user having the Space Age expansion.
			\|-
			\| <code>highlighted_fields</code> \|\| Object{"name", "owner", "summary", "title"} \|\| \|\| \|\| \|\| ✓
			\| The fields that <code>query</code> field matched against, the matching text surrounded by the text specified with the <code>highlight_*_tag</code> parameters.
	\|}		\|}