TheCarriedOne: Publish from docs/data-api.md

2026-11-02T12:19:58Z

Publish from docs/data-api.md

New page

[[Data API|Data API]] · [[Data API/Types|Types]]

== <code><nowiki>factions/get</nowiki></code> ==

Returns a single faction.

Request

<pre>{ "type": "factions/get", "id": 1 }</pre>

Response — [[Data API/Types#Faction|<code><nowiki>Faction</nowiki></code>]]

== <code><nowiki>factions/members</nowiki></code> ==

Returns all users that belong to a faction.

Request

<pre>{ "type": "factions/members", "id": 1 }</pre>

Response — [[Data API/Types#User|<code><nowiki>User[]</nowiki></code>]]

== <code><nowiki>factions/recruiting</nowiki></code> ==

Returns recruiting factions of the viewer's profile type with an open member spot and at least one FP-funded active boost. Open Recruitment factions rank ahead of those requiring approval; within each group, sorting uses descending Monthly FP deposited, Lifetime FP deposited, then faction ID. Request-required factions must also be below the pending-request limit; factions with Open Recruitment do not need request capacity. Each profile type's list is limited to the configured browser size after filtering and ranking. Data is cached for up to 15 minutes and invalidated when recruiting-card fields change; active boosts are rechecked against current FP drain when serving cached rows.

Request

<pre>{ "type": "factions/recruiting" }</pre>

Response

<pre>{ lastUpdated: number; data: Faction[] }</pre>

== <code><nowiki>factions/joinRequests</nowiki></code> ==

Returns faction join requests filtered by either faction or user.

Request

<pre>{ "type": "factions/joinRequests", "id": 1, "idType": "factionId" }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>id</nowiki></code>
| positive integer
| yes
| faction ID or BcID
|-
| <code><nowiki>idType</nowiki></code>
| <code><nowiki>"factionId"</nowiki></code> | <code><nowiki>"bcId"</nowiki></code>
| yes
| determines what <code><nowiki>id</nowiki></code> refers to
|}

Response — [[Data API/Types#FactionJoinRequest|<code><nowiki>FactionJoinRequest[]</nowiki></code>]]

== <code><nowiki>factions/leaderboard</nowiki></code> ==

Returns a paginated page of the faction leaderboard.

Request

<pre>{ "type": "factions/leaderboard", "stat": "fpDepositedMonthly", "page": 1 }</pre>

{| class="wikitable"
|-
! Field
! Type
! Required
! Notes
|-
| <code><nowiki>stat</nowiki></code>
| <code><nowiki>"fpDepositedMonthly"</nowiki></code> | <code><nowiki>"fpDepositedTotal"</nowiki></code>
| yes
|
|-
| <code><nowiki>page</nowiki></code>
| positive integer
| yes
| 1-based
|-
| <code><nowiki>pageSize</nowiki></code>
| positive integer
| no
| defaults to server-configured value
|-
| <code><nowiki>profileType</nowiki></code>
| <code><nowiki>"main"</nowiki></code> | <code><nowiki>"ironman"</nowiki></code>
| no
| scopes rankings to factions owned by players of that profile mode (hardcore is not supported as hardcore profiles cannot own factions)
|}

Response — [[Data API/Types#LeaderboardPage|<code><nowiki>LeaderboardPage<FactionLeaderboardEntry></nowiki></code>]]

Each entry contains faction identity and display fields, the ranking stats, and the optional owner profile type:

<pre>{
id: number
tag: string | null
name: string
customizationSettings: FactionCustomizationSettings
ownerPremiumExpiryDate: Date | null
fpDepositedMonthly: number
fpDepositedTotal: number
ownerType?: "main" | "ironman" | "hardcore"
}</pre>

Generated from the Bconomy source documentation. Edits made on the wiki are overwritten on the next publish; ask the developers to change the source.

[[Category:Data API]]

Data API/Factions - Revision history

TheCarriedOne: Publish from docs/data-api.md