ttvdrops/templates/core/docs_rss.html
Joakim Hellsén 8229b0fe80
All checks were successful
Deploy to Server / deploy (push) Successful in 28s
Add support for a hide_paid query parameter to campaign feeds
2026-05-05 06:05:10 +02:00

164 lines
8.3 KiB
HTML

{% extends "base.html" %}
{% load static %}
{% block title %}
RSS Feeds Documentation
{% endblock title %}
{% block content %}
<main>
<h1>RSS Feeds Documentation</h1>
<p>
You have three types of feeds available for Twitch drops data: RSS, Atom, and Discord.
RSS and Atom feeds are similar and can be used in any RSS reader application.
The main difference is that Atom feeds include additional metadata and support for more complex content, while RSS feeds are more widely supported by older applications.
</p>
<p>
Discord feeds are available under the <code>/discord/</code> endpoints. These are Atom feeds
that include Discord relative timestamps (e.g., <code>&lt;t:1773450272:R&gt;</code>) for dates,
making them ideal for Discord bots and integrations. Future enhancements may include Discord-specific formatting or content.
</p>
<p>
Twitch JSON API documentation is available at
<a href="{% url 'twitch:twitch-api-v1:openapi-view' %}">/twitch/api/v1/docs</a>.
</p>
<p>
Twitch campaign feeds accept <code>?limit=50</code> to change item count and
<code>?hide_paid=1</code> to hide subscription-gated drops and skip campaigns
with no free drops.
</p>
<section>
<h2>Global RSS Feeds</h2>
<table>
<thead>
<tr>
<th>Description</th>
<th>RSS</th>
<th>Atom</th>
<th>Discord</th>
</tr>
</thead>
<tbody>
<tr>
<td>New Twitch games</td>
<td>
<a href="https://ttvdrops.lovinator.space/rss/games/">https://ttvdrops.lovinator.space/rss/games/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/atom/games/">https://ttvdrops.lovinator.space/atom/games/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/games/">https://ttvdrops.lovinator.space/discord/games/</a>
</td>
</tr>
<tr>
<td>Latest Twitch drops</td>
<td>
<a href="https://ttvdrops.lovinator.space/rss/campaigns/">https://ttvdrops.lovinator.space/rss/campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/atom/campaigns/">https://ttvdrops.lovinator.space/atom/campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/campaigns/">https://ttvdrops.lovinator.space/discord/campaigns/</a>
</td>
</tr>
<tr>
<td>Latest Twitch organizations</td>
<td>
<a href="https://ttvdrops.lovinator.space/rss/organizations/">https://ttvdrops.lovinator.space/rss/organizations/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/atom/organizations/">https://ttvdrops.lovinator.space/atom/organizations/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/organizations/">https://ttvdrops.lovinator.space/discord/organizations/</a>
</td>
</tr>
<tr>
<td>Latest Twitch reward campaigns</td>
<td>
<a href="https://ttvdrops.lovinator.space/rss/reward-campaigns/">https://ttvdrops.lovinator.space/rss/reward-campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/atom/reward-campaigns/">https://ttvdrops.lovinator.space/atom/reward-campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/reward-campaigns/">https://ttvdrops.lovinator.space/discord/reward-campaigns/</a>
</td>
</tr>
<tr>
<td>Latest Kick drops</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/rss/campaigns/">https://ttvdrops.lovinator.space/kick/rss/campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/atom/campaigns/">https://ttvdrops.lovinator.space/kick/atom/campaigns/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/campaigns/">https://ttvdrops.lovinator.space/discord/campaigns/</a>
</td>
</tr>
<tr>
<td>Latest Kick games</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/rss/games/">https://ttvdrops.lovinator.space/kick/rss/games/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/atom/games/">https://ttvdrops.lovinator.space/kick/atom/games/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/games/">https://ttvdrops.lovinator.space/discord/games/</a>
</td>
</tr>
<tr>
<td>Latest Kick organizations</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/rss/organizations/">https://ttvdrops.lovinator.space/kick/rss/organizations/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/kick/atom/organizations/">https://ttvdrops.lovinator.space/kick/atom/organizations/</a>
</td>
<td>
<a href="https://ttvdrops.lovinator.space/discord/organizations/">https://ttvdrops.lovinator.space/discord/organizations/</a>
</td>
</tr>
</tbody>
</table>
</section>
{% if game %}
<section>
<h2>Filtered RSS Feeds</h2>
<p>You can subscribe to RSS feeds scoped to a specific game.</p>
<table>
<thead>
<tr>
<th>Game</th>
<th>RSS</th>
<th>Atom</th>
<th>Discord</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{ game.display_name }}</td>
<td>
<a href="{% url 'core:game_campaign_feed' game.twitch_id %}">
https://ttvdrops.lovinator.space/rss/games/{{ game.twitch_id }}/
</a>
</td>
<td>
<a href="{% url 'core:game_campaign_feed_atom' game.twitch_id %}">
https://ttvdrops.lovinator.space/atom/games/{{ game.twitch_id }}/
</a>
</td>
<td>
<a href="{% url 'core:game_campaign_feed_discord' game.twitch_id %}">
https://ttvdrops.lovinator.space/discord/games/{{ game.twitch_id }}/
</a>
</td>
</tr>
</tbody>
</table>
</section>
{% endif %}
</main>
{% endblock content %}