API access and formats
Pages 4
Clone this wiki locally
Serialized Formats
StopModReposts provides its site list in various data formats that may be useful for developers. These list formats are available by querying an external API. We ask API users to be mindful about their request volume and to cache the site list. Please do not request the list more than once every 12 hours if possible. You may embed the list in your application if you find this to be a feasible approach. An identifying user-agent (preferrably with some kind of contact information included) is required for all API requests.
The StopModReposts list by StopModReposts is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Based on a work at http://git.io/jaBI.
ℹ By using the API you agree to send annonymous usage data to our third party provider(s). More info below.
General usage
- To request the format of a specific game list, add the list's name between the request domain and path. E.g. All lists: https://api.stopmodreposts.org/sites.json, Minecraft only: https://api.stopmodreposts.org/minecraft/sites.json (because of minecraft.yaml).
- Empty site attributes are filled with "/". E.g.
"path": "/"
.
JavaScript Object Notation (JSON)
Request
https://api.stopmodreposts.org/sites.json
Response
[
{
"domain": "example.com",
"notes": "Malware alert!",
"path": "/",
"reason": "Illegal redistribution"
},
...
]
Extensible Markup Language (XML)
Request
https://api.stopmodreposts.org/sites.xml
Response
<sites>
<site>
<domain>example.com</domain>
<notes>Malware alert!</notes>
<path>/</path>
<reason>Illegal redistribution</reason>
</site>
...
</sites>
YAML Ain't Markup Language (YAML)
Request
https://api.stopmodreposts.org/sites.yaml
Response
- domain: example.com
notes: Malware alert!
path: /
reason: Illegal redistribution
...
Plain text
Request
https://api.stopmodreposts.org/sites.txt
Response
example.com
example.net
example.org
...
Hosts file (HOSTS.TXT)
Request
https://api.stopmodreposts.org/hosts.txt
Response
# Informational header at the top of the file
0.0.0.0 example.com
0.0.0.0 example.net
0.0.0.0 example.org
...
0.0.0.0 www.example.com
0.0.0.0 www.example.net
0.0.0.0 www.example.org
...
# === End of StopModReposts site list ===
uBlacklist format
Request
https://api.stopmodreposts.org/ublacklist.txt
Response
*://*.example.com/*
*://*.example.net/*
*://*.example.org/*