Jump to Content
Guides
API Reference
Changelog
Discussions
v1.0
Log In
API Reference
Log In
v1.0
Guides
API Reference
Changelog
Discussions
Getting Started with the APIs
All
Pages
Start typing to search…
JUMP TO
Overview
Getting Started with the APIs
Errors and error handling
Metadata
Football API
Countries
Get countries
get
Competitions
Get competitions.
get
Get most followed competitions
get
Get competition by ID
get
Teams
Get teams
get
Get most followed teams
get
Get team by ID
get
Players
Get players
get
Get players points for a specified template
get
Get player positions for matches in a specified template
get
Get most followed players
get
Get player by ID
get
Get detailed player points for a specified template
get
Matches
Get matches
get
Get player match statistics
get
Get matches by template
get
Get match by ID
get
Get player's next match
get
Get player's last match
get
Get team's next match
get
Get team's last match
get
Search
Search
get
ID Mapping API
Football
Get football ID mappings
get
Create football ID mapping.
post
Get missing football IDs for a provider
get
Get top entities
get
Update ID mapping
patch
Summary
Get ID mapping summary
get
Profile API
Countries
Get countries
get
Followers
Follow profiles
post
Unfollow profiles
del
Get your own followers
get
Get Follow Status for Specific Profiles
get
Get the profiles you are following
get
Get user's followers
get
Get the profiles a user is following
get
Leads
Get all leads
get
Create a new lead
post
Export leads
get
Get lead statistics
get
Get lead by ID
get
Profiles
Get your own profile
get
Delete own profile
del
Update your own profile
patch
Get user profiles
get
Get profile by ID
get
Delete user profile by id
del
Update user profile verified and/or staff member status
post
Collect user consent
post
Retrieve user consent data
get
Profiles Detailed
Get user profiles with details.
get
Badge Resource
Get user's own badges
get
Get user's badges
get
User Data
Delete user data
del
External Activities
Get user's own external activities
get
Get external activities for user
get
Consume external activities for user
post
Save external activities for profile
post
Consents
Export users by consent IDs
get
Delete a consent item
del
Prediction API
Games
Get games
get
Create a new game
post
Get game by ID
get
Update game
patch
Get match outcomes for a game
get
Get predictions for a game
get
Get game leaderboard
get
Custom Brackets
Get list of custom bracket games.
get
Create custom bracket game.
post
Get custom bracket game by id.
get
Update an existing custom bracket game by id.
put
Get predictions for a custom bracket game
get
Create a new prediction for a custom bracket game
post
Update a prediction for a custom bracket game
put
Get custom bracket game rankings by id.
get
Predictions
Get user's own predictions
get
Create new prediction
post
Get predictions by ids
get
Get aggregated prediction results for a match
get
Get prediction's user data
get
Get user's predictions
get
Get prediction by id
get
Delete prediction
del
Update prediction
patch
Winners Resource
Gets the list of winners for a particular contest (game or template)
get
Updates the list of winners for a particular contest (game or template)
put
Sets the list of winners for a particular contest (game or template)
post
Announce the winners for a particular contest (game or template).
post
Custom Standings
Get list of custom standing games.
get
Create custom standings game.
post
Get predictions for a custom standing game
get
Create a new prediction for a custom standing game
post
Update a prediction for a custom standing game
put
Get custom standing game rankings by id.
get
Get custom standings game by id.
get
Update an existing custom standings game by id.
put
Custom Leaderboards
Get list of custom leaderboards.
get
Create custom leaderboard.
post
Get custom leaderboard by id.
get
Update an existing custom leaderboard.
put
Delete an existing custom leaderboard.
del
Get custom leader board rankings by id.
get
Custom Event
Get list of custom event games.
get
Create custom event game.
post
Get custom event game by id.
get
Update an existing custom event game by id.
put
Get predictions for a custom event game
get
Create a new prediction for a custom event game
post
Update a prediction for a custom event game
put
Get custom event game rankings by id.
get
Loyalty API
Ranks
Get leaderboard for a game
get
Get all leaderboards for user
get
Get leaderboard for a template
get
Get gameweek statistics for a template.
get
Activity
Get own activities
get
Create new activity
post
Delete activity
del
Get user's activities
get
Excluded
Exclude profile ids from specific game
put
Points
Reward user with external points
post
Private League
User rankings for user for private leagues.
get
User rankings for private league.
get
Rank Detailed
Get detailed user game ranks
get
Get detailed user template ranks
get
Top
Get best predictors.
get
Statistics
Get own tiers and points
get
Get user's tiers and points
get
Engagement Coefficients
Get all of the engagement coefficients for a particular profile.
get
Follows statistics
Get follows breakdown for specified entity list
get
Templates
List templates
get
Create template
post
Get template by id
get
Update template
put
Delete template
del
Contest Resource
Executes a check if all profiles has predictions for a particular contest (game or template)
get
Reporting API
Users
Get acquired users
get
Get users per country
get
Monthly active users
get
Monthly active users vs registrations
get
Users in RFM groups
get
Users in RFM segments
get
Get total users for a period
get
Classic Quizzes
Get Classic Quizzes participations
get
Get most participated Classic Quizzes
get
Clients
Get platform averages
get
Get platform acquired users
get
Get platform total users for period.
get
Get audit log by id.
get
Discussions
Average number of posts.
get
% of users with at least 1, 5, 10, 50 and 100 posts.
get
Top 100 contributors.
get
Top 100 discussions.
get
Breakdown of total number of discussions per period of time.
get
Breakdown of total number of posts per period of time.
get
Either/Or
Get Either/Or participations
get
Get most participated Either/Or games
get
Export users
Export users based on criteria.
post
Follows
Get average follows per user
get
Get top 20 followed competitions
get
Get user breakdown for a competition
get
Get follows breakdown for specified entity list
get
Get top 100 followed football players
get
Get user breakdown for a player
get
Get top 100 followed teams
get
Get user breakdown for a team
get
Get user breakdown for a profile
get
Get top followed sports
get
Get user breakdown for a sport
get
Get top followed 50 users
get
Metrics
Get platform consumption
get
Get platform consumption
get
Participations
User breakdown for game.
get
Count users by country for game.
get
Count users by engagement for game.
get
Count users by gender for game.
get
Count new players ratio for game.
get
Player of the match
Get 'Player of the match' count of users who voted and total votes
get
Predictions
Counts predictions for markets per period.
get
Engagement through predictions.
get
Counts predictions per entity.
get
Counts predictions per match.
get
Counts total predictions for markets.
get
Private league users
User stats for private leagues.
get
Private leagues
Get total number of private leagues for a period of time.
get
Private league top templates
Top 20 templates with most private leagues.
get
Markets
Get success rates for all markets and overall percentage.
get
Entity
Get success rates for entity.
get
Personality Quizzes
Get Personality Quizzes participations
get
Get most participated Personality Quizzes
get
Mini-Games API
Classic Quizzes
Get a list of classic quizzes
get
Create classic quiz
post
Migrate rank for a classic quiz
post
User's own participations in classic quizzes
get
Ranking for classic quizzes
get
Get user ranking
get
Get a classic quiz
get
Update classic quiz
put
Delete classic quiz
del
Participate in a classic quiz
post
Get classic quiz question reports.
get
Update a classic quiz question report.
post
Results summary.
get
Get a classic quiz by staff member
get
Either/Or
Get a list of Either/Or games
get
Create Either/Or trivia game
post
Get Either/Or trivia game
get
Update Either/Or trivia game
put
Delete Either/Or trivia game
del
Get own statistics for Either/Or game
get
Participate in Either/Or
post
Get results for Either/Or game
get
Get an Either/Or game by staff member
get
Personality Quizzes
Get a list of personality quizzes
get
Create personality quiz
post
Get personality quiz by ID
get
Update personality quiz
put
Delete personality quiz
del
Get personality quiz by ID
get
Get personality quiz participations
get
Participate in personality quiz
post
Share personality quiz participations
get
Discussions API
Discussions
Create a discussion
post
Get discussion
get
Get discussions
get
Get top discussions
get
Delete a discussion
del
Get a list of posts count per discussion ID
get
Posts
Create a post
post
Get posts for discussion
get
Update a post
put
Delete a post
del
Get user's posts
get
Get user's own posts
get
Get all posts for all discussions by staff member.
get
Get a single post
get
Get posts count from many discussions
post
Unpin posts
del
Pin posts
patch
Reported posts in private league's discussion
get
Reported posts in public discussion
get
React to a post
put
Get post replies
get
Report a post
post
Moderation
Bulk moderation for posts by user id, discussion id or post ids
post
Moderate a post from staff member in public discussion
post
Moderate a post in private league by league admin
post
Ban user from specified discussion
post
Unban a user.
del
Retrieve the user's active ban and ban history.
get
Private Leagues API
Leagues
Get leagues
get
Create league
post
Get league
get
Update league
put
Delete league
del
Update league template
post
Membership
Accept invite for private league
post
Ban users from private league
post
Show league invites
get
Invite users to private league
post
Delete invites from private league
del
Join private league with invitation code
post
Leave private league
post
Remove ban of users from private league
post
Predictions
Get predictions
get
Voting API
Polls
Get poll list
get
Create poll
post
Get user's votes
get
Get poll
get
Update poll
put
Delete poll
del
Get user's poll vote
get
Vote for a poll
put
Delete poll's votes
del
Player of the match
Get user's own votes for 'Player of the match'.
get
Get results for 'Player of the match'
get
Vote for 'Player of the match'
put
Delete vote for 'Player of the match'
del
Search API
Unified Search
Search content
get
Powered by
Getting Started with the APIs
Ask AI
This page will help you get started with Fans United APIs.
