# The Swarm

## Docs

- [Errors](https://docs.theswarm.com/docs/api-reference/errors.md): Diagnose and resolve API errors with ease.
- [API Reference](https://docs.theswarm.com/docs/api-reference/introduction.md)
- [Pagination](https://docs.theswarm.com/docs/api-reference/pagination.md): Handling queries with large responses
- [Rate limiting](https://docs.theswarm.com/docs/api-reference/rate-limiting.md): Optimize API usage with rate limits and retry guidance.
- [Fetch Company](https://docs.theswarm.com/docs/endpoints/fetch-company.md): This endpoint offers seamless access to detailed information about Companies stored in our internal database. Whether you're looking to retrieve specific company details for analysis, integration, or other purposes, the Fetch Company endpoint provides a straightforward solution. Simply provide the c…
- [Fetch Profile](https://docs.theswarm.com/docs/endpoints/fetch-profile.md): The Fetch endpoint within the API facilitates the retrieval of specific profiles from the database based on their unique identifiers (profile IDs or LinkedIn usernames). This endpoint is designed to provide detailed information about individual profiles stored in the database, allowing users to acce…
- [Network Mapper API](https://docs.theswarm.com/docs/endpoints/network-mapper.md): Find connected profiles with their connection details
- [Search Company](https://docs.theswarm.com/docs/endpoints/search-companies.md): This endpoint provides a powerful tool for searching our internal database of Companies. As our database primarily consists of employees, this functionality enables users to discover company information efficiently. By utilizing the Search Company endpoint, you can query our database to find relevan…
- [Search Profiles](https://docs.theswarm.com/docs/endpoints/search-profiles.md): The Search Profiles endpoint facilitates searching for profiles within the profile database based on their attributes. Utilizing OpenSearch as the underlying database technology, this endpoint accepts requests with OpenSearch domain-specific language (DSL), enabling powerful and flexible search quer…
- [Fetch endpoint](https://docs.theswarm.com/docs/examples/fetch-endpoint.md)
- [Network Mapper endpoint](https://docs.theswarm.com/docs/examples/network-mapper-endpoint.md)
- [API Query Builder](https://docs.theswarm.com/docs/examples/query-builder.md): Convert natural language into OpenSearch DSL and can run it against the Swarm API, delivering both the query and live results in one interface.
- [API Query Tester](https://docs.theswarm.com/docs/examples/query-tester.md): Test your OpenSearch DSL queries against the Swarm API and see real results.
- [Search endpoint](https://docs.theswarm.com/docs/examples/search-endpoint.md)
- [Canonical Values ](https://docs.theswarm.com/docs/getting-started/canonical-values.md): Simplify finding relevant data with standardized values
- [Definitions](https://docs.theswarm.com/docs/getting-started/definitions.md): The Swarm API definitions outline how profiles, companies, connections, connectors, and teams are structured and enriched to map relationship networks and surface trusted connection paths.
- [FAQ](https://docs.theswarm.com/docs/getting-started/faq.md): Find answers to common questions and troubleshooting tips for using the The Swarm API, including error handling, best practices, and debugging guidance
- [Introduction](https://docs.theswarm.com/docs/getting-started/introduction.md): Seamless integration and powerful data access to The Swarm database.
- [Quick Start](https://docs.theswarm.com/docs/getting-started/quickstart.md): Welcome to The Swarm API implementation guide.
- [Install MCP for Claude Desktop](https://docs.theswarm.com/docs/integrations/install-mcp.md): The Swarm MCP Server is now available as a for Claude Desktop using the new .mcpb (Model Context Protocol Bundle) package format. No terminal commands, no configuration files, no technical setup required.
- [MCP Server](https://docs.theswarm.com/docs/integrations/mcp.md): The Swarm MCP Server provides professional profile data retrieval capabilities through the Model Context Protocol (MCP). This is a remote MCP server that requires HTTP proxy communication, making it different from traditional local MCP servers that run directly on your machine.
- [Company](https://docs.theswarm.com/docs/models/company.md): Overview of the data model representing a record returned by the Fetch Company endpoint.
- [Flat Files](https://docs.theswarm.com/docs/models/flat-file.md): Flat files are bulk data dumps of The Swarm's entire proprietary database including all fields described in this API documentation, meant for customers who want to host the data themselves and ingest it directly. Flat files give you faster access to the data, and more flexibility on your end.
- [Live Enrichment](https://docs.theswarm.com/docs/models/live-enrichment.md)
- [OpenSearch Company Mappings](https://docs.theswarm.com/docs/models/mappings-company.md): Below is the comprehensive OpenSearch field mapping for company data.
- [OpenSearch Profile Mappings](https://docs.theswarm.com/docs/models/mappings-profile.md): Below is the comprehensive OpenSearch field mapping for profile data.
- [Overview](https://docs.theswarm.com/docs/models/network-mapper-api.md): The Swarm API lets you explore network connections using OpenSearch DSL, with results in JSON for seamless integration. Secure access via API key ensures reliable data retrieval.
- [For Partners (Multi-team)](https://docs.theswarm.com/docs/models/network-mapper-api-partner.md)
- [Profile](https://docs.theswarm.com/docs/models/profile.md): Overview of the data model representing a profile returned by the Fetch endpoint
- [Social Engagement](https://docs.theswarm.com/docs/models/social-engagement.md)
- [Get Comments](https://docs.theswarm.com/docs/on-demand/get-comments.md): Pulls all comments for a given social media post.
- [Get Company Posts](https://docs.theswarm.com/docs/on-demand/get-company-posts.md): Pulls posts from a company's social media accounts. Returns the latest 10 posts by default — use the perPage parameter to request up to 100. The response includes a postUrn for each post, which is used as the input for the Get Comments, Get Reactions, and Get Reshares endpoints.
- [Get Profile Posts](https://docs.theswarm.com/docs/on-demand/get-profile-posts.md): Pulls posts from a profile's social media accounts. Returns the latest 10 posts by default — use the perPage parameter to request up to 100. The response includes a postUrn for each post, which is used as the input for the Get Comments, Get Reactions, and Get Reshares endpoints.
- [Get Reactions](https://docs.theswarm.com/docs/on-demand/get-reactions.md): Pulls all reactions for a given social media post.
- [Get Reshares](https://docs.theswarm.com/docs/on-demand/get-reshares.md): Pulls all reshares for a given social media post.
- [Refresh a Profile](https://docs.theswarm.com/docs/on-demand/refresh-profile.md): Triggers an on-demand refresh of a profile's data from available sources, returning the most current version of their LinkedIn information.
- [Add Connector](https://docs.theswarm.com/docs/team-management/connector.md): Add a new connector account to an existing team via API
- [Create Team](https://docs.theswarm.com/docs/team-management/team.md): This endpoint allows customers with partner API key to create new teams and access them with a single API key

## OpenAPI Specs

- [openapi](https://docs.theswarm.com/openapi.json)