Einführung

Dieser endpoint ermöglicht es, Communities anhand von Schlüsselwörtern zu suchen und zu entdecken.

Der endpoint akzeptiert ein oder mehrere Schlüsselwörter als Abfrage. Standardmäßig gibt eine Anfrage sowohl öffentliche als auch geschlossene Communities zurück, die der angegebenen Abfrage entsprechen.

Kontoeinrichtung

Um auf diese endpoints zuzugreifen, benötigen Sie:

• Ein genehmigtes Developer-Konto.
• Eine Authentifizierung mit den Keys und Tokens aus einer Developer-App, die sich innerhalb eines Project befindet. 

Erfahren Sie mehr über den Zugriff auf die X API v2 endpoints in unserem Leitfaden für den Einstieg.

Erste Schritte

​

Authentifizierung

Sie können dieses endpoint entweder mit OAuth 1.0a User Context, [OAuth 2.0 App-Only](https://developer.x.com(/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token), oder OAuth 2.0 Authorization Code mit PKCE authentifizieren.  

​

Eine Anfrage senden

Sie können das endpoint „Search Communities“ wie unten gezeigt aufrufen:

      curl --location 'https://api.x.com/2/communities/search?query=anime' --header 'Authorization: ••••••'

Wenn die Anfrage erfolgreich ist, sollten Sie die JSON-Antwort wie unten gezeigt sehen:

{
   "data": [
       {
           "access": "Public",
           "description": "Willkommen in der Anime-Community! Hier treffen sich Anime-Fans, um ihre Lieblingssendungen zu teilen und über alles rund um Anime zu diskutieren.",
           "join_policy": "Open",
           "name": "Anime Community"
       },
       {
           "access": "Public",
           "description": "Tritt bei und schreib über Anime 🥰",
           "join_policy": "Open",
           "name": "Anime World 🌸"
       },
       {
           "access": "Public",
           "description": "Für alle Anime-Liebhaber und -Ersteller!",
           "join_policy": "Open",
           "name": "Anime"
       },
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}

​

Community-Felder

Sie können zusätzliche data abrufen, die einer Community zugeordnet sind, indem Sie Community-Felder angeben.

Die folgenden Community-Felder sind verfügbar:

Feldwert	Typ	Beschreibung
created_at	Datum (ISO 8601)	Erstellungszeitpunkt der Community.
id	string	Der eindeutige Bezeichner der Community.
name	string	Der Name der Community.
description	string	Der Text der Community-Beschreibung, falls vorhanden.
access	string	Die Zugriffsebene der Community. Mögliche Werte: * Public * Closed
join_policy	string	Die Beitrittsrichtlinie der Community. Mögliche Werte: * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	Anzahl der Mitglieder, die der Community beigetreten sind.

​

Beispielanfrage

Sie können den Search Communities endpoint mit zusätzlichen Community fields wie unten gezeigt aufrufen:

      curl --location 'https://api.x.com/2/communities/search?query=anime&community.fields=access,created_at,description,id,join_policy,member_count,name' --header 'Authorization: ••••••'

Beispielantwort

Wenn die Anfrage erfolgreich ist, sollten Sie die JSON-Antwort wie unten gezeigt sehen:

{
   "data": [
       {
           "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI=",
           "description": "Willkommen in der Anime-Community! Hier treffen sich Anime-Fans, um ihre Lieblings-Serien zu teilen und über alles rund um Anime zu diskutieren.",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 39915,
           "name": "Anime-Community",
           "created_at": "2024-02-17T06:58:50.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE1MDY3OTM5NTMxMDYwNDI4OTE=",
           "description": "Tritt bei und schreibe über Anime 🥰",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 26019,
           "name": "Anime-Welt 🌸",
           "created_at": "2022-03-24T00:44:07.000Z"
       },
       {
           "id": "Q29tbXVuaXR5OjE0OTY3NzYyMTU5Mzk1MzQ4NDk=",
           "description": "Für alle Anime-Liebhaber und Creators!",
           "join_policy": "Open",
           "access": "Public",
           "member_count": 5612,
           "name": "Anime",
           "created_at": "2022-02-24T09:17:13.000Z"
       }
   ],
   "meta": {
       "next_token": "7140dibdnow9c7btw481s8m561gat797rboud5r80xvzm"
   }
}