Community
A community: its name, description, members, topic, rules and who made it.
GET/v1/twitter/communities1 creditHeaders
Get your API keyx-api-key*stringrequiredheaderYour API key, made in the dashboard.
Parameters
2community_idstringoptionalqueryA community's id: the digits after /communities/ in its link. Give community_id or url.
example: 1733520006279815231
urlstringoptionalqueryA community's link: x.com/i/communities/<id>. Give community_id or url.
max 300 chars
Response fields
24dataobjectThe result: one object, or a list for the endpoints that return several.
data.idstringX's id for the community: digits, written as text.
data.urlstringThe community's link.
data.namestringnullableIts name.
data.descriptionstringnullableWhat it is about, as its admins wrote it.
data.membersintegernullableMembers.
data.topicstringnullableIts topic, as X files it: Software, Sports and so on.
data.join_policystringnullableOpen: anyone can join; Closed: its admins approve each member.
data.nsfwbooleannullableWhether it is marked as not safe for work.
data.rulesstring[]nullableIts rules' names.
data.creator_handlestringnullableThe handle of the account that made it.
data.bannerstringnullableIts banner image's link.
data.created_atstringnullableWhen it was made.
format: date-time
pageobjectnullablePaging, for the endpoints that page; null for the others.
page.next_cursorstringnullableSend it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.
page.has_morebooleanoptionalWhether another page follows.
default: false
metaobjectAbout this call.
meta.platformstringThe platform: reddit, threads, tiktok or youtube.
meta.endpointstringThe endpoint's name, such as channel_videos.
meta.paramsobjectThe call's parameters, defaults included. Parameters without a value, and the cursor, are left out.
meta.request_idstringThis call's id. Quote it when you report a problem.
meta.api_versionstringThe API version that answered.
meta.fetched_atstringWhen the data was fetched from the platform (UTC).
format: date-time
meta.cachedbooleanoptionalWhether it came from our cache; fetched_at says how old it is.
default: false
Code example
curl -X GET 'https://api.socialparse.dev/v1/twitter/communities?community_id=1733520006279815231' \ -H 'x-api-key: YOUR_API_KEY'Responses
Successful Response
{ "data": { "id": "string", "url": "string", "name": "string", "description": "string", "members": 0, "topic": "string", "join_policy": "string", "nsfw": true, "rules": [ "string" ], "creator_handle": "string", "banner": "string", "created_at": "2019-08-24T14:15:22Z" }, "page": { "next_cursor": "string", "has_more": false }, "meta": { "platform": "string", "endpoint": "string", "params": { "property1": "string", "property2": "string" }, "request_id": "string", "api_version": "string", "fetched_at": "2019-08-24T14:15:22Z", "cached": false }}