What Are the Available Brandmentions API Endpoints?

The BrandMentions API is organized around a set of commands, often referred to as endpoints, that you call through a single base URL.

Each command tells the API what you want to do, such as:

Create a new on the spot search
Fetch mentions or metrics
Manage projects
Check your remaining credits

Understanding these commands is the first step to using the BrandMentions API effectively.

All requests go through the same base URL:

https://api.brandmentions.com/command.php

You specify what you want to do using the command parameter, and you authenticate using your api_key.

Example:

https://api.brandmentions.com/command.php?api_key=YOUR_API_KEY&command=GetRemainingCredits

Main BrandMentions API commands (endpoints)

Below is an overview of the main API commands available in the BrandMentions API and what you can use them for.

1. PostSearch

Command: PostSearch

Creates a new search job that runs on the spot.

Starts processing immediately in the background
Returns a search_hash that uniquely identifies the job
You use this search_hash with other commands to retrieve results

Typical use cases:

On demand searches for specific keywords or topics
One off checks for a campaign, product, or event

2. GetMentions

Command: GetMentions

Retrieves the full results of a search job created with PostSearch.

Requires the search_hash returned by PostSearch
Returns all available mentions that match the search job criteria
Ideal when the search processing is complete and you want the final dataset

Typical use cases:

Exporting all mentions for reporting or analysis
Feeding mentions into dashboards or data pipelines

3. GetProcessedMentions

Command: GetProcessedMentions

Returns partial results of a search job while it is still running.

Also uses the search_hash from PostSearch
Lets you start working with mentions before the job is fully complete
Useful for real time or near real time applications

Typical use cases:

Live dashboards that show mentions as they come in
Monitoring trending topics or crisis situations in progress

4. GetRemainingCredits

Command: GetRemainingCredits

Returns the number of API credits you have left in your account.

Simple but essential command
Helps you monitor usage and avoid unexpected interruptions

Example request:

https://api.brandmentions.com/command.php?api_key=YOUR_API_KEY&command=GetRemainingCredits

Typical use cases:

Displaying credit usage in internal tools
Automatically alerting your team when credits get low

5. AddProject

Command: AddProject

Creates a new project in your BrandMentions account.

You can configure:

Keywords and phrases to monitor
Languages
Countries
Other project level settings

Typical use cases:

Programmatically setting up projects for new brands or clients
Standardizing project creation across multiple environments or workspaces

6. ListProjects

Command: ListProjects

Returns a list of all projects in your BrandMentions account.

Useful for discovering project IDs or names
Often used as a first step before fetching mentions or influencers for a project

Typical use cases:

Building project selectors in dashboards or tools
Auditing existing projects across an account

7. DeleteProject

Command: DeleteProject

Deletes a project from your BrandMentions account.

Permanently removes the project and its configuration
Use with caution, especially in automated scripts

Typical use cases:

Cleaning up test or temporary projects
Removing projects for inactive brands or campaigns

8. GetProjectMentions

Command: GetProjectMentions

Retrieves mentions for a specific project that already exists in your account.

Uses project level configuration (keywords, filters) defined in BrandMentions
Can be combined with date ranges and other filters, depending on the API parameters

Typical use cases:

Feeding project mentions into BI tools
Exporting mentions for reporting, sentiment analysis, or AI models

9. GetProjectInfluencers

Command: GetProjectInfluencers

Returns a list of top influencers for a specific project.

Focuses on authors, sources, or profiles that drive significant reach or engagement
Helps you identify key voices talking about your brand or topic

Typical use cases:

Influencer discovery and outreach
Identifying priority accounts for campaigns or relationship building

10. RunProjectHistorical

Command: RunProjectHistorical

Runs a historical search for a project.

Backfills project data for a specified period
Useful when you add a project and want past data, not only future mentions

Typical use cases:

Getting historical context for a new project
Preparing before and after comparisons for campaigns or events

11. EditProject

Command: EditProject

Updates the settings of an existing project.

You can modify:

Keywords
Filters such as language or geography
Other project specific configuration

Typical use cases:

Refining tracking as your brand or campaigns evolve
Correcting or improving existing project setups

12. GetMentionsCount

Command: GetMentionsCount

Returns the number of mentions that match a given set of filters.

Does not return the full mention data
Useful when you only need metrics, not complete results

Typical use cases:

Trend charts and aggregated dashboards
Fast checks of volume across time, topics, or projects

How to call BrandMentions API commands

All commands use the same base pattern.

You send a GET or POST request to:

https://api.brandmentions.com/command.php

With parameters such as:

api_key
command
Other command specific parameters (for example project ID, filters, dates)

Example using GetRemainingCredits:

https://api.brandmentions.com/command.php?api_key=YOUR_API_KEY&command=GetRemainingCredits

To use other commands, simply change the command value and add the required parameters.