API

Vote badge

A self-updating image showing the clan's rank and vote count. Drop it on your site or forum signature — it always shows current numbers, and links back to your listing when you wrap it in a link.

GET https://battlefieldclans.net/api/clans/{slug}/badge            → SVG (default)
GET https://battlefieldclans.net/api/clans/{slug}/badge?format=png → PNG, 560×144

Use the SVG on the web — it's sharp at any size. Use the PNG where SVG isn't rendered, most notably Discord.

Embedding

<!-- HTML -->
<a href="https://battlefieldclans.net/clans/{slug}">
  <img src="https://battlefieldclans.net/api/clans/{slug}/badge" alt="Our clan on Battlefield Clans" width="280" height="72">
</a>

<!-- Markdown -->
[![Our clan](https://battlefieldclans.net/api/clans/{slug}/badge)](https://battlefieldclans.net/clans/{slug})

<!-- BBCode -->
[url=https://battlefieldclans.net/clans/{slug}][img]https://battlefieldclans.net/api/clans/{slug}/badge[/img][/url]

Your clan page has these snippets ready to copy with your slug already filled in.

Examples

curl

curl https://battlefieldclans.net/api/clans/7th-cavalry-gaming/votes

JavaScript (browser or Node)

const res = await fetch(
  "https://battlefieldclans.net/api/clans/7th-cavalry-gaming/votes"
);
const clan = await res.json();
console.log(`${clan.name}: ${clan.votes} votes, rank #${clan.rank}`);

Stream overlay

A self-contained widget you can point OBS's Browser Source at. Save it as an HTML file locally.

<div id="votes">—</div>
<script>
  const SLUG = "your-clan-slug";
  async function tick() {
    try {
      const r = await fetch(
        `https://battlefieldclans.net/api/clans/${SLUG}/votes`
      );
      const c = await r.json();
      document.getElementById("votes").textContent =
        `${c.votes} votes · #${c.rank}`;
    } catch {}
  }
  tick();
  setInterval(tick, 60000);
</script>

Python

import requests

clan = requests.get(
    "https://battlefieldclans.net/api/clans/7th-cavalry-gaming/votes"
).json()
print(clan["votes"], clan["rank"])

Discord bot

If you just want vote counts in your Discord server, you don't need the API — our bot does it for you.

/votes-watch takes a style — a new message each time, or one widget message that keeps updating itself — and a look: a rich embed, a single line of plain text, or the same badge card shown above.

Fair use

• ·No key, no signup, no hard rate limit — but responses are cached, so polling faster than every 15 seconds gains you nothing.
• ·The data is public information about public listings. Please don't use it to build a mirror of the directory.
• ·Endpoints may gain fields over time. They won't have fields removed or renamed without notice, so parse defensively and ignore what you don't recognise.
• ·Building something that needs more than this? Get in touch and tell us what you need.