> ## Documentation Index > Fetch the complete documentation index at: https://docs.sociavault.com/llms.txt > Use this file to discover all available pages before exploring further. # Community > Get the details of a Twitter(X) Community 💳 **1 credit** per request ## OpenAPI ````yaml GET /v1/scrape/twitter/community openapi: 3.1.0 info: title: SociaVault API version: 1.0.0 description: >- # SociaVault API Documentation The SociaVault API provides comprehensive access to social media data extraction across multiple platforms. ## Features - **Multi-Platform Support**: TikTok, Instagram, YouTube, Facebook, Twitter, Reddit, Threads, and more - **Credit-Based System**: Pay-as-you-go pricing with transparent credit costs - **High Performance**: Fast, reliable data extraction - **Comprehensive Data**: Detailed user profiles, videos, posts, comments, and analytics ## Authentication All API requests require authentication using an API key in the `X-API-Key` header: ```bash X-API-Key: sk_live_your_api_key_here ``` Get your API key from the [SociaVault Dashboard](https://sociavault.com/dashboard). ## Credits Each endpoint consumes credits based on data complexity: - Simple requests (profiles): 1 credit - Complex requests (demographics): 20+ credits - Paginated requests: Credits per page Check your credit balance in the dashboard or via the API. ## Support - **Documentation**: https://docs.sociavault.com - **Email**: support@sociavault.com - **Discord**: https://discord.gg/sociavault contact: name: SociaVault Support email: support@sociavault.com url: https://sociavault.com/support license: name: Commercial url: https://sociavault.com/terms servers: - url: https://api.sociavault.com description: Production API security: - ApiKeyAuth: [] tags: - name: account description: Account management and credit balance externalDocs: description: Learn more url: https://docs.sociavault.com/account - name: tiktok description: Scrape TikTok profiles, videos, and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/tiktok - name: tiktok-shop description: Everything about TikTok Shop externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/tiktok-shop - name: instagram description: Gets Instagram profiles, posts, and reels externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/instagram - name: youtube description: Scrape YouTube channels, videos, and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/youtube - name: linkedin description: Scrape LinkedIn externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/linkedin - name: facebook description: Get public Facebook profiles and posts externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/facebook - name: facebookAdLibrary description: Scrapes the Facebook (Meta) Ad Library externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/facebookAdLibrary - name: facebookMarketplace description: Search Facebook Marketplace and pull full listing details externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/facebookMarketplace - name: googleAdLibrary description: >- Scrape the Google Ad Transparency Library. *This only gets the public ads. Some ads you need to log in for and sadly we can't get those. Also, since there are so many variations, the return types might not all be 100% the same. externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/googleAdLibrary - name: linkedinAdLibrary description: Search the LinkedIn Ad Library externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/linkedinAdLibrary - name: twitter description: Get Twitter profiles, tweets, followers and more externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/twitter - name: reddit description: Scrape Reddit posts and comments externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/reddit - name: threads description: Get Threads posts externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/threads - name: google description: Scrape Google search results externalDocs: description: Learn more url: https://docs.sociavault.com/platforms/google paths: /v1/scrape/twitter/community: get: tags: - twitter summary: Community description: Get the details of a Twitter(X) Community operationId: twitter_Community parameters: - name: url in: query description: Community URL required: true schema: type: string example: https://x.com/i/communities/1926186499399139650 responses: '200': description: >- Successful response **Key Response Fields:** - `rest_id`: Unique community ID - `name`: Community display name - `description`: Community description text - `join_policy`: Membership policy (`Open`, `RestrictedJoin`, etc.) - `created_at`: Unix timestamp (ms) of community creation - `member_count`: Total number of community members - `role`: Your role in the community (e.g. `NonMember`) - `is_member`: Boolean indicating membership status - `creator_results.result.core.screen_name`: @handle of the community creator - `rules[0].name` / `description`: Community rules - `custom_banner_media.media_info.original_img_url`: Banner image URL - `is_nsfw`: Whether the community is marked NSFW content: application/json: example: success: true data: success: true __typename: Community is_member: false name: The First Thousand role: NonMember rest_id: '1926186499399139650' actions: join_action_result: __typename: CommunityJoinActionUnavailable id: Q29tbXVuaXR5QWN0aW9uczoxOTI2MTg2NDk5Mzk5MTM5NjUw description: >- This community is for creators and builders who are growing to their first 1,000 followers. Give insights, build your brand, and grow a loyal audience. creator_results: result: __typename: User id: VXNlcjoxOTIxMzY4NDU0NDQ5MjAxMTUy is_blue_verified: true core: screen_name: carsonrmccann verification: verified: false id: VXNlclJlc3VsdHM6MTkyMTM2ODQ1NDQ0OTIwMTE1Mg== join_policy: Open created_at: 1748073622931 rules: '0': rest_id: '1926189963793609186' description: >- This isn’t the space to drop ChatGPT engineered empty platitudes name: No Empty Platitudes id: Q29tbXVuaXR5UnVsZToxOTI2MTg5OTYzNzkzNjA5MTg2 custom_banner_media: media_info: __typename: ApiImage color_info: palette: '0': rgb: red: 217 green: 0 blue: 17 percentage: 85.22 original_img_url: >- https://pbs.twimg.com/community_banner_img/1930048753223745537/Ua814CNc?format=jpg&name=orig original_img_width: 1250 original_img_height: 500 id: QXBpTWVkaWE6DAATCgABGsjpHX8WQAEAAA== default_banner_media: media_info: __typename: ApiImage color_info: palette: '0': rgb: red: 118 green: 88 blue: 254 percentage: 36.26 original_img_url: https://pbs.twimg.com/media/FECS7TfVcAcCrj2.jpg original_img_width: 1200 original_img_height: 480 id: QXBpTWVkaWE6DAABCgABFECS7TfVcAcKAAITiFWq8lUQBAAA members_facepile_results: '0': result: __typename: User avatar: image_url: >- https://pbs.twimg.com/profile_images/1963429128402501632/J9C5efvR_normal.jpg id: VXNlcjoxOTIxMzY4NDU0NDQ5MjAxMTUy id: VXNlclJlc3VsdHM6MTkyMTM2ODQ1NDQ0OTIwMTE1Mg== '1': result: __typename: User avatar: image_url: >- https://pbs.twimg.com/profile_images/2011557694264479744/xS6eyqBz_normal.jpg id: VXNlcjo0MDA2ODgyNzYx id: VXNlclJlc3VsdHM6NDAwNjg4Mjc2MQ== '2': result: __typename: User avatar: image_url: >- https://pbs.twimg.com/profile_images/1947507215373332480/8oK6TPt5_normal.jpg id: VXNlcjoxOTI0NTI2MDM1NTUyNjMyODMy id: VXNlclJlc3VsdHM6MTkyNDUyNjAzNTU1MjYzMjgzMg== '3': result: __typename: User avatar: image_url: >- https://pbs.twimg.com/profile_images/1960798665720668160/VU298_nF_normal.jpg id: VXNlcjoxMDExNjE5NTY4NTA5NTA5NjMy id: VXNlclJlc3VsdHM6MTAxMTYxOTU2ODUwOTUwOTYzMg== '4': result: __typename: User avatar: image_url: >- https://pbs.twimg.com/profile_images/1790570742247043072/uyEKz7o__normal.jpg id: VXNlcjoxMTkyNTYxNzY4NTc0NDcyMTky id: VXNlclJlc3VsdHM6MTE5MjU2MTc2ODU3NDQ3MjE5Mg== member_count: 5533 invites_result: __typename: CommunityInvitesUnavailable join_requests_result: __typename: CommunityJoinRequestsUnavailable is_nsfw: false trending_hashtags_slice: __typename: CommunityHashtagSlice items: {} id: Q29tbXVuaXR5OjE5MjYxODY0OTkzOTkxMzk2NTA= credits_used: 1 endpoint: twitter/community '400': description: Bad Request - Invalid parameters or missing required fields content: application/json: schema: type: object properties: error: type: string example: 'Missing required parameter: handle' endpoint: type: string credits_required: type: integer required: - error '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: error: type: string example: Invalid API key docs: type: string example: https://docs.sociavault.com/authentication required: - error '402': description: Payment Required - Insufficient credits content: application/json: schema: type: object properties: error: type: string example: Insufficient credits required: type: integer example: 1 description: Credits required for this request available: type: integer example: 0 description: Credits currently available required: - error - required - available '500': description: Internal Server Error - Service configuration or processing error content: application/json: schema: type: object properties: error: type: string example: Service configuration error required: - error components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: |- API key for authentication. Format: `sk_live_xxxxxxxxxxxxx` Get your API key from the [Dashboard](https://sociavault.com/dashboard). ````