v2.0
OpenAPI 3.0.3
7 endpoints

Free Fire Community API

The Free Fire Community API gives developers REST access to Free Fire player profiles, career statistics, ban status, guild details, Craftland maps, wishlists and in-game assets across the SG, IND and BR regions.

Quick start

  1. Create an API key on the Developer Platform.
  2. Call an endpoint from your server with the x-api-key header and a custom User-Agent header (required, see Required User-Agent below).
curl "https://developers.freefirecommunity.com/api/v1/info?region=ind&uid=665951869" \
  -H "x-api-key: your_api_key_here" \
  -H "User-Agent: MyApp/1.0 (+https://example.com/my-app)"

Features

  • Player profile data, rankings and clan membership
  • Career statistics for Solo, Duo and Squad modes
  • Ban status checking
  • Guild (clan) information
  • Craftland map details
  • Player wishlists
  • In-game images and icons
  • Multi-region support: SG, IND and BR
  • Server-side caching for fast responses

Authentication

Authenticate every request with your API key, using either method:

  • Header (recommended): x-api-key: your_api_key_here. The key stays out of URLs and logs.
  • Query parameter: ?key=your_api_key_here. Convenient for quick tests, but less secure.

Keys start with ffc_ and are at least 30 characters long. A missing key returns AUTH_001, and an invalid key returns AUTH_002.

Required User-Agent

Every request passes through an edge firewall before authentication. Server-side integrations and bots must send a custom User-Agent header, or they are blocked with a 403 (or 429) and an FW_00x code before the API key is even checked.

Rules

  • Send a User-Agent of at least 10 characters.
  • It must not contain HTTP library or automation names anywhere in the string, for example curl, python, requests, axios, node-fetch, Go-http-client, okhttp, java, wget, bot, scrapy, puppeteer, playwright, selenium, postman, insomnia or httpie. Matching is case-insensitive and substring-based, so bot matches even inside a URL such as github.com/user/my-bot.
  • The default User-Agents of fetch/undici, Python requests, Go net/http and curl are blocked. Override the header explicitly.
  • Recommended format: AppName/1.0 (+https://your-site-or-repo).

Firewall codes

  • FW_001 (403): User-Agent missing or shorter than 10 characters.
  • FW_002 (403): User-Agent matches a blocked library or bot pattern.
  • FW_003 (403): User-Agent reports a very old browser version.
  • FW_004 (429): too many requests from one IP (edge rate limit). Honor Retry-After.

A 403 with an FW_ code is a firewall or User-Agent problem, not an API key, plan or region issue. The region parameter never affects the firewall or authorization.

Regions

Most endpoints accept a region query parameter:

  • sg: Singapore region. Covers SG, ID, ME, VN, TH, CIS, EU, TW, MY, PK, BD.
  • ind: India region. Covers India only.
  • br: Brazil region. Covers BR, US, NA, LATAM.

Rate limits and quota

Limits depend on your plan:

  • Trial: playground only. No API key and no production usage.
  • Trial Pass: 500 total requests (one-time), 20 requests/minute, 100 requests/hour.
  • Beginner: 5,000 requests/month, 30 requests/minute, 500 requests/hour.
  • Developer: 15,000 requests/month, 60 requests/minute, 2,000 requests/hour.
  • Pro: 50,000 requests/month, 120 requests/minute, 6,000 requests/hour.
  • Enterprise: 100,000+ requests/month, custom rate limits.

Top-up credits and upgrade carry-over credits are added on top of your monthly quota.

Quota cost. Most endpoints use 1 unit of monthly quota per request. /stats uses 2 units. The cost is returned in the X-Quota-Cost response header. Per-minute and per-hour burst limits always count each request as 1.

Per-IP abuse guard. In addition to plan limits, requests are counted per IP address over a 5-minute window. Free and trial plans allow 30 requests per window. Paid plans allow at least max(30, per-minute limit × 5). Exceeding it returns 429 with code: RATE_001 and type: ip-based.

Response headers. Successful responses include X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (per-minute window), X-RateLimit-Hour-Limit, X-RateLimit-Hour-Remaining and X-RateLimit-Hour-Reset (per-hour window), plus X-Quota-Cost, X-Response-Time, X-API-Version and X-Cache (HIT or MISS).

Caching

Upstream data is cached server-side. Cached responses return X-Cache: HIT and X-Cache-TTL, and they still count against your quota and rate limits.

  • /info, /stats, /guild: 5 minutes
  • /bancheck, /wishlist: 10 minutes
  • /craftland: 15 minutes
  • /image: 1 hour

Errors

Errors are returned as JSON with a stable code:

  • AUTH_001: missing API key
  • AUTH_002: invalid API key
  • AUTH_003: inactive API key
  • AUTH_004: expired API key
  • RATE_001: rate limit exceeded (per-minute, per-hour or per-IP)
  • QUOTA_001: monthly quota exhausted
  • PARAM_001: missing parameter
  • RES_001: resource not found
  • SYS_001: internal error
  • SYS_002: service unavailable or data provider failure
  • SYS_003: data provider timeout
  • FW_001 to FW_004: edge firewall (see Required User-Agent above)

Security and privacy

  • Make API requests from your server to protect your API key.
  • Never expose your API key in client-side code. Rotate it if it is compromised.
  • We do not store or share personal player data.
  • All data comes from publicly available information.

Disclaimer

This API and the Free Fire Community platform are not affiliated with, endorsed by, or connected to Garena International or Free Fire. This is an independent, community-driven project. All trademarks, game content and assets belong to their respective owners.

Support and community

Get an API key and read the full documentation

Base URLs

  • https://developers.freefirecommunity.com/api/v1

    Production API server (version 1)

Authentication

  • ApiKeyAuthAPI key in header: x-api-key

    Your API key, sent in the x-api-key header. Recommended. Create a key on the Developer Platform.

    • Keep the key server-side. Never ship it in client-side code.
    • Rotate it immediately if it is compromised.
  • ApiKeyQueryAuthAPI key in query: key

    Your API key, sent as the key query parameter. Convenient for quick tests, but the key can appear in URLs and logs. Prefer the x-api-key header in production.

Player Information

Player profile data, rankings, clan and account information.

get/info

Get player information

Returns a player's profile: account details, rank, badges, clan membership, pet, equipped items, credit score and season data.

  • Basic account details (nickname, level, rank, likes)
  • Badge and banner information
  • Clan (guild) membership details
  • Pet information and skills
  • Equipped items and skins
  • Credit score and diamond cost

Use the region that matches the player's account region.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • regionstring

    Region of the player's account. Recommended on every request.

    • sg: Singapore region (SG, ID, ME, VN, TH, CIS, EU, TW, MY, PK, BD)
    • ind: India region (India only)
    • br: Brazil region (BR, US, NA, LATAM)

    When omitted, /stats and /wishlist default to ind and /craftland defaults to sg. /info forwards the value to the data provider as-is.

    Allowedsgindbr
  • uidstringrequired

    The player's unique User ID (5 to 15 digits).

Responses

  • 200

    Player information retrieved.

    application/json

    Response schema

    Response 200

    PlayerInfoResponse
    • basicInfoPlayerBasicInforequired

      Core account and ranking information.

      Show child attributes
      • accountIdstring

        Player account ID.

      • nicknamestring

        Player display name.

      • levelinteger

        Account level.

      • rankinteger

        Current Battle Royale rank.

      • maxRankinteger

        Highest Battle Royale rank reached.

      • csRankinteger

        Current Clash Squad rank.

      • csMaxRankinteger

        Highest Clash Squad rank reached.

      • rankingPointsinteger

        Current ranking points.

      • regionstring

        Account region.

      • seasonIdinteger

        Current season ID.

      • likedinteger

        Number of likes the profile has received.

      • titlestring

        Equipped title.

      • badgeIdstring

        Equipped badge ID.

      • bannerIdstring

        Equipped banner ID.

    • captainBasicInfoPlayerBasicInfo

      Core account and ranking information.

      Show child attributes
      • accountIdstring

        Player account ID.

      • nicknamestring

        Player display name.

      • levelinteger

        Account level.

      • rankinteger

        Current Battle Royale rank.

      • maxRankinteger

        Highest Battle Royale rank reached.

      • csRankinteger

        Current Clash Squad rank.

      • csMaxRankinteger

        Highest Clash Squad rank reached.

      • rankingPointsinteger

        Current ranking points.

      • regionstring

        Account region.

      • seasonIdinteger

        Current season ID.

      • likedinteger

        Number of likes the profile has received.

      • titlestring

        Equipped title.

      • badgeIdstring

        Equipped badge ID.

      • bannerIdstring

        Equipped banner ID.

    • clanBasicInfoClanBasicInfo

      Clan (guild) the player belongs to.

      Show child attributes
      • clanIdstring

        Clan ID.

      • clanNamestring

        Clan name.

      • captainIdstring

        Account ID of the clan captain.

      • clanLevelinteger

        Clan level.

      • memberNuminteger

        Current number of members.

      • capacityinteger

        Maximum number of members.

    • petInfoPetInfo

      The player's pet.

      Show child attributes
      • idstring

        Pet ID.

      • skinIdstring

        Equipped pet skin ID.

      • selectedSkillIdstring

        Selected pet skill ID.

      • levelinteger

        Pet level.

      • expinteger

        Pet experience points.

      • isSelectedboolean

        Whether this pet is currently equipped.

    • creditScoreInfoCreditScoreInfo

      Account credit score and reward state.

      Show child attributes
      • creditScoreinteger

        Current credit score.

      • rewardStartAtstring

        Reward period start.

      • rewardEndAtstring

        Reward period end.

      • rewardStateinteger

        Reward state code.

      • rewardTypeinteger

        Reward type code.

    • diamondCostResDiamondCostResponse

      Diamond spending summary.

      Show child attributes
      • diamondCostinteger

        Diamonds spent.

    • profileInfoProfileInfo

      Equipped avatar, clothes and skills.

      Show child attributes
      • avatarIdstring

        Equipped avatar ID.

      • clothesstring[]

        IDs of equipped clothing items.

      • equipedSkillsobject[]

        Equipped character skills.

      • isSelectedboolean

        Whether this profile setup is currently selected.

      • isSelectedAwakenboolean

        Whether the awakened variant is selected.

    • socialInfoSocialInfo

      Social profile details.

      Show child attributes
      • accountIdstring

        Player account ID.

      • signaturestring

        Profile signature text.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 500

    Internal server error (SYS_001). Include the requestId when contacting support.

    application/json

    Response schema

    Response 500

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Player Statistics

Career gameplay statistics for Solo, Duo and Squad modes.

get/stats

Get player statistics

Returns a player's all-time career statistics for each Battle Royale mode (Solo, Duo, Squad).

  • Total games played, wins and eliminations
  • Highest eliminations in a single match
  • Headshot statistics
  • Vehicle eliminations
  • Knockdowns and revives (Duo and Squad)
  • Top placement counts (top 3, top 5, top 10)

Quota cost: each request uses 2 units of monthly quota (reported in the X-Quota-Cost header). Burst limits still count it as 1.

Region: optional. Defaults to ind when omitted.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • regionstring

    Region of the player's account. Recommended on every request.

    • sg: Singapore region (SG, ID, ME, VN, TH, CIS, EU, TW, MY, PK, BD)
    • ind: India region (India only)
    • br: Brazil region (BR, US, NA, LATAM)

    When omitted, /stats and /wishlist default to ind and /craftland defaults to sg. /info forwards the value to the data provider as-is.

    Allowedsgindbr
  • uidstringrequired

    The player's unique User ID (5 to 15 digits).

Responses

  • 200

    Player statistics retrieved.

    application/json

    Response schema

    Response 200

    PlayerStatsResponse
    • brCareer_soloobject

      Solo mode career statistics.

    • brCareer_duoobject

      Duo mode career statistics.

    • brCareer_squadobject

      Squad mode career statistics.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 500

    Internal server error (SYS_001). Include the requestId when contacting support.

    application/json

    Response schema

    Response 500

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 502

    The data provider failed or returned a non-JSON response (SYS_002). Includes upstreamStatus when available. Safe to retry. Retry-After is 5 seconds on connection failures.

    application/json

    Response schema

    Response 502

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 504

    The data provider did not respond within 8 seconds (SYS_003). Retry after the Retry-After interval (5 seconds).

    application/json

    Response schema

    Response 504

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Player Ban Check

Check whether a player account is banned or has an active ban period.

get/bancheck

Check player ban status

Checks whether a Free Fire player account is currently banned or has an active ban period.

Note: the upstream check is currently always performed with lang=en, so the lang parameter does not change the response language yet.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • uidstringrequired

    The player's unique User ID (5 to 15 digits).

  • langstring

    Language for the response.

    Allowedenaresidptruvi

    Default: "en"

Responses

  • 200

    Ban check completed.

    application/json

    Response schema

    Response 200

    BanCheckResponse
    • statusstring

      Status of the ban check request.

    • dataobject
      Show child attributes
      • is_bannedinteger

        1 if the account is banned, otherwise 0.

        Allowed01
      • periodinteger

        Ban period reported by the data provider.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Player Wishlist

Items on a player's in-game wishlist.

get/wishlist

Get player wishlist

Returns the items on a player's in-game wishlist.

Region: optional. Defaults to ind when omitted.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • regionstring

    Region of the player's account. Recommended on every request.

    • sg: Singapore region (SG, ID, ME, VN, TH, CIS, EU, TW, MY, PK, BD)
    • ind: India region (India only)
    • br: Brazil region (BR, US, NA, LATAM)

    When omitted, /stats and /wishlist default to ind and /craftland defaults to sg. /info forwards the value to the data provider as-is.

    Allowedsgindbr
  • uidstringrequired

    The player's unique User ID (5 to 15 digits).

Responses

  • 200

    Wishlist retrieved.

    application/json

    Response schema

    Response 200

    WishlistResponse
    • wishlist_itemsobject[]

      Wishlist entries.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 404

    Player not found or wishlist is empty.

    application/json

    Response schema

    Response 404

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Guild Information

Guild (clan) details.

get/guild

Get guild information

Returns guild (clan) information. Query parameters other than the API key are forwarded to the data provider.

Region: optional. Defaults to br when omitted.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • regionstring

    Region code of the guild.

    Allowedsgindbr

    Default: "br"

Responses

  • 200

    Guild information retrieved.

    application/json

    Response schema

    Response 200

    object

    Guild details as returned by the data provider.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 502

    The data provider failed or returned a non-JSON response (SYS_002). Includes upstreamStatus when available. Safe to retry. Retry-After is 5 seconds on connection failures.

    application/json

    Response schema

    Response 502

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 504

    The data provider did not respond within 8 seconds (SYS_003). Retry after the Retry-After interval (5 seconds).

    application/json

    Response schema

    Response 504

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Craftland Maps

Custom Craftland maps and user-generated content.

get/craftland

Get Craftland map information

Returns detailed information about a specific Craftland custom map.

Region: optional. Defaults to sg when omitted.

Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • regionstring

    Region of the player's account. Recommended on every request.

    • sg: Singapore region (SG, ID, ME, VN, TH, CIS, EU, TW, MY, PK, BD)
    • ind: India region (India only)
    • br: Brazil region (BR, US, NA, LATAM)

    When omitted, /stats and /wishlist default to ind and /craftland defaults to sg. /info forwards the value to the data provider as-is.

    Allowedsgindbr
  • codestringrequired

    The Craftland map code.

Responses

  • 200

    Map information retrieved.

    application/json

    Response schema

    Response 200

    CraftlandMapResponse
    • map_infoobject

      Details of the requested map.

  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 404

    Map not found.

    application/json

    Response schema

    Response 404

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time

Game Assets

In-game images, icons and other visual assets.

get/image

Get game asset image

Returns an in-game image or icon from the Free Fire asset database, such as:

  • Character avatars and skins
  • Weapon skins and icons
  • Item and equipment icons
  • Badges and banners
  • Pet images
Requires
ApiKeyAuth (API key in header: x-api-key)
ApiKeyQueryAuth (API key in query: key)

Parameters

Query

  • itemIDstringrequired

    The item ID to retrieve the image for.

Responses

  • 200

    Image retrieved.

    image/png

    Response schema

    Response 200

    string · binary
  • 400

    Bad request. A required parameter is missing or invalid (for example PARAM_001).

    application/json

    Response schema

    Response 400

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 401

    Unauthorized. The key is missing (AUTH_001) or invalid (AUTH_002). Keys start with ffc_ and are at least 30 characters.

    application/json

    Response schema

    Response 401

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 403

    Forbidden. Two causes: (1) an edge firewall block, where the error code starts with FW_ (for example FW_001 for a missing or short User-Agent, FW_002 for a blocked User-Agent pattern). Set a valid custom User-Agent header. (2) The API key is inactive (AUTH_003) or expired (AUTH_004). The region is never the cause.

    application/json

    Response schema

    Response 403

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 404

    Image not found.

    application/json

    Response schema

    Response 404

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time
  • 429

    Too many requests. The code is RATE_001 (per-minute, per-hour or per-IP limit; check window and type), QUOTA_001 (monthly quota exhausted; see used, limit, requestCost and resetDate), or FW_004 (edge firewall limit; honor Retry-After).

    application/json

    Response schema

    Response 429

    ErrorResponse
    • successboolean

      Example: false

    • errorstring

      Short error name.

    • messagestring

      Human-readable explanation.

    • codestring

      Machine-readable error code: AUTH_001 (missing key), AUTH_002 (invalid key), AUTH_003 (inactive key), AUTH_004 (expired key), RATE_001 (rate limit), QUOTA_001 (monthly quota), PARAM_001 (missing parameter), RES_001 (not found), SYS_001 (internal error), SYS_002 (service unavailable), SYS_003 (upstream timeout), or FW_001 to FW_004 (edge firewall).

      Example: "AUTH_001"

    • requestIdstring

      Request identifier, included on 5xx errors. Quote it when contacting support.

    • retryAfterinteger

      Seconds to wait before retrying, when applicable.

    • documentationstring · uri

      Link to documentation for this error.

    • timestampstring · date-time