Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[GET] /community/clan/find

Example request

Searches for clans by name, tags, and join policy. Returns a paginated list of matching clans.

Request

parametertypevaluecomments
titlestr/enumage1, age2, age3, age4Game title
joinPoliciesarr[int][0,1,2]Filter by join policy
namestr“GL”Clan name substring to search for
tagsarr[str][]Filter by tags
startint0Pagination offset
countint100Number of results to return

Response

AoE2:DE

Returns a clans array containing clan objects that match the search criteria. The example below is trimmed to 2 entries; a real response may contain up to count results.

{
    "result": {
        "code": 0,
        "message": "SUCCESS"
    },
    "clans": [
        {
            "id": 9221,
            "name": "SME",
            "fullname": "Swiss_Martial_Eagle",
            "description": "",
            "tags": "",
            "icon": "",
            "membercount": 4,
            "joinpolicy": 0,
            "metadata": "",
            "messageoftheday": "",
            "statgroup_id": 458620
        },
        {
            "id": 8254,
            "name": "GTwn",
            "fullname": "Glendorians",
            "description": "",
            "tags": "",
            "icon": "",
            "membercount": 1,
            "joinpolicy": 1,
            "metadata": "",
            "messageoftheday": "",
            "statgroup_id": 414313
        }
    ]
}
fieldtypedescription
idintUnique clan identifier
namestringShort clan tag (max 5 characters)
fullnamestringFull display name of the clan
descriptionstringClan description text
tagsstringComma-separated tags
iconstringClan icon identifier (e.g. "CR-001")
membercountintCurrent number of members
joinpolicyintJoin policy (0 = open, 1 = invite/request only)
metadatastringAdditional metadata (JSON string)
messageofthedaystringClan message of the day
statgroup_idintAssociated stat group identifier