📘

API Docs - Choriper

Automatic documentation for public project APIs

Automatic documentation for public APIs used across the Choriper project systems. This page is generated automatically from the public endpoint files.

You can support the project in USD through Ko-fi, or in BRL through the official RIP-BF store.

🏠 Go to Home 💵 Support in USD 🇧🇷 Support in BRL
📁 Folder: /endpoints/ 🧩 Files: .js 📌 Endpoints: 4
🔎
🔌

getGameAchievements

Returns a player's achievements for a specific game. The response is normalized and returns offer information plus an items array with each achievement.

GET
Share#gameachievements
URLhttps://rip-bf.com/api/player-global/gameAchievements/?id=1007917900222&game=bfv

🧭 Usage type

Examplehttps://rip-bf.com/api/player-global/gameAchievements/?id=1007917900222&game=bfv

Use this to fetch Battlefield V achievements using the game shortcut.

⚠️ Warnings

  • You must provide id.
  • Use only one game selector: game OR gameSlug.
  • When gameSlug is provided, it overrides the game shortcut.
  • The response is normalized and is not returned in the original GraphQL format.
🧾 Parameters 5 fields
id
Required. Player PSD / userId. Example: 1007917900222
game
Optional. Game shortcut. Supported values: bfv, bf1, bf4, bf6, apex, bf2042, fc24, bf3. Use this OR gameSlug.
gameSlug
Optional. Direct OfferId / offerId string. Example: Origin.OFR.50.0002859. When provided, it overrides game.
show-hidden
Optional. Boolean. Default: true. When true, includes hidden achievements.
locale
Optional. Response language. Default: pt-br. Examples: en-us, es-es, pt-br.
📦 Response fields 11 fields
offerId
Game offer ID used to fetch the achievement set.
setId
Achievement set ID. Can be null when unavailable.
items
Array of normalized achievement objects.
id
Achievement ID.
name
Achievement name.
description
Achievement description.
awardCount
Achievement award count / value.
howTo
How to unlock the achievement. Can be null.
date
Unlock date or related achievement date. Can be null.
isHidden
Boolean indicating whether the achievement is hidden.
image
Single achievement image URL. Usually the LG / -416.png image when available.

🧪 Example

curl -X GET "https://rip-bf.com/api/player-global/gameAchievements/?id=1007917900222&game=bfv&show-hidden=true&locale=en-us"
▶ Test GET endpoint
🔌
getTokenInfo
Returns information about the currently authenticated RIP-BF user. This endpoint requires an active logged-in session and reads the user's session cookies automatically.
POST
Share#gettokeninfo
URLhttps://rip-bf.com/api/token/
🧭 Usage type
Examplehttps://rip-bf.com/api/token/
Use this from the browser or a same-site page when the user is already logged in.
⚠️ Warnings
  • This endpoint requires an active logged-in session.
  • A plain curl request without valid cookies will usually return unauthenticated.
  • Do not expose private session cookies or returned tokens publicly.
  • Use this endpoint to identify the current logged-in user before calling protected routes.
🧾 Parameters 2 fields
session
Required indirectly. The user must be logged in on RIP-BF. The endpoint uses the active browser/session cookies.
body
No body is required for the default session check.
📦 Response fields 9 fields
error
Boolean indicating whether the request failed.
success
Boolean indicating whether the authenticated session is valid, when returned by the API.
message
Request status message.
ea_id
EA account / Nucleus ID associated with the logged-in user.
ea_pd
EA PD ID associated with the logged-in user, when available.
user_id
Internal RIP-BF user ID, when available.
username
Logged-in user's name or display name, when available.
permissions
User permissions array or permission data, when available.
access_token
Session/API token returned by the endpoint, when available.
🧪 Example
curl -X POST "https://rip-bf.com/api/token/"
▶ Test POST endpoint
🔌
player-get-user
Returns public EA player data, including avatar, display name, user identifiers, and optionally owned games. Supports single and bulk lookups using comma-separated userId values. CORS is supported.
GETCACHE 7200s
Share#player-get-user
URLhttps://rip-bf.com/api/player-global/get-user/?userId=1016334900222&GetGames=true
🧭 Usage type
Examplehttps://rip-bf.com/api/player-global/get-user/?userId=1016334900222&GetGames=true
Use this for a profile page when you need player data and owned games.
⚠️ Warnings
  • Bulk requests are supported. Use comma-separated userId values.
  • For very large jobs, split requests into reasonable batches to avoid browser, gateway, or timeout limits.
  • Use this endpoint for public EA profile data, avatar, names, identifiers, and owned games.
🧾 Parameters 3 fields
userId
Required. One EA userId or multiple EA userIds separated by commas. Example: 1016334900222 or 1018232638027,1012773239907,1013933006150
GetGames
Optional. Boolean. When true, includes owned games in the response.
GetGames-tags
Optional. Boolean. When true, returns only game tags instead of full game data.
📦 Response fields 10 fields
error
Boolean indicating whether the request failed.
count
Number of users returned.
users
Array of public EA player objects.
displayName
Player display name.
uniqueName
Player unique EA name.
nickname
Player nickname, when available.
userId
EA userId.
id
EA persona/player id, when available.
avatarUrl
Player avatar URL.
games
Owned games, when GetGames=true.
🧪 Example
curl -X GET "https://rip-bf.com/api/player-global/get-user/?userId=1016334900222&GetGames=true"
▶ Test GET endpoint
🔌
player-global
Resolves EA account identifiers from RIP-BF. You can query by EA username, Nucleus ID, email, or batch name list. Returns core EA identifiers such as ea_id and ea_pd, used by other EA-related APIs. Responses are cached for 1 hour.
GETCACHE 3600s
Share#player-global
URLhttps://rip-bf.com/api/eaid/?name=jn-nicolas
🧭 Usage type
Examplehttps://rip-bf.com/api/eaid/?name=jn-nicolas
Use this when you have the player's EA username / EAID.
⚠️ Warnings
  • You must provide at least one query parameter: name, nucleus_id, email, or namelist.
  • Responses are cached for 1 hour to improve speed and reduce repeated lookups.
  • For namelist usage, split very large lists into reasonable batches to avoid gateway or timeout limits.
🧾 Parameters 4 fields
name
Optional. Player EA username / EAID. Example: jn-nicolas
nucleus_id
Optional. EA Nucleus ID. Numeric account identifier. Example: 1000171162866
email
Optional. Account email. Example: choriper@rip-bf.com
namelist
Optional. Batch lookup by player names. Can be a single name or multiple names, depending on backend support. Example: choriper or ADM-RIP,jn-nicolas,anotherName
📦 Response fields 7 fields
success
Boolean indicating whether the request was successful.
message
Request status message.
user_id
Internal RIP-BF user ID, if the user exists in the database.
ea_id
EA account / Nucleus ID.
ea_pd
EA PD ID. Persistent identifier used in EA GraphQL and other EA-related APIs.
name
Resolved EA username, when available.
results
Batch result list, when using namelist.
🧪 Example
curl -X GET "https://rip-bf.com/api/eaid/?name=jn-nicolas"
▶ Test GET endpoint

    


    

        Automatically generated by reading .js files inside the /endpoints/ folder.