Boostramp - SEO co-pilot

API - Keywords

API gateway

https://app.boostramp.com/api/keyword.php?token=%token%&func=%function%


Required GET fields 

token - Your API session token. Learn how to log in and obtain your session token

func - The API function you wish to call

For guidance on how to use the Boostramp API, refer to our API usage example article 


Endpoints

1. getRankingHistory

Keywords ranking data

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getRankingHistory

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) date_start (date, optional): Report start date in Y-m-d format, default - 1 month ago
  • (GET) date_end (date, optional): Report end date in Y-m-d format, default - today


2. getRankingSummary

keywords ranking summary

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getRankingSummary

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) date_start (date, optional): Report start date in Y-m-d format, default - 1 month ago
  • (GET) date_end (date, optional): Report end date in Y-m-d format, default - today


3. getSnapshots

get SERP snapshot for keyword

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getSnapshots

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) keyword_id (int, required): Keyword ID
  • (GET) date_start (date, optional): Report start date in Y-m-d format, default - 1 month ago
  • (GET) date_end (date, optional): Report end date in Y-m-d format, default - today


4. getProjectKeywords

Get list of project keywords

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getProjectKeywords

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) sort (string, optional): "name", "w-volume", "l-volume", default "name"
  • (GET) order (optional): ASC or DESC, default ASC


5. removeKeyword

Delete keyword

Endpoint 

https://app.boostramp.com/api/keyword.php?func=removeKeyword

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) keyword_id (int, required): Keyword ID


6. removeGroup

Delete Group

Endpoint 

https://app.boostramp.com/api/keyword.php?func=removeGroup

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) group_id (int, required): Group ID


7. addGroup

Create new group

Endpoint 

https://app.boostramp.com/api/keyword.php?func=addGroup

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (POST) group_name (string, required): Group name (5 to 100 characters)


8. getKeywordsGroups

Get the list of Groups

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getKeywordsGroups

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


9. updatesStatus

Get volume and ranking update process status

Endpoint 

https://app.boostramp.com/api/keyword.php?func=updatesStatus

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


10. updateRanking

Start ranking scan

Endpoint 

https://app.boostramp.com/api/keyword.php?func=updateRanking

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


11. updateVolume

Start keywords search volume update

Endpoint 

https://app.boostramp.com/api/keyword.php?func=updateVolume

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


12. addKeywords

Add new keywords

Endpoint 

https://app.boostramp.com/api/keyword.php?func=addKeywords

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (POST) keywords (string, required): List of new keywords. One per line ("\n" separator)


13. getTotalKeywordsByUser

count all keywords in the account (total keywords in all projects)

Endpoint 

https://app.boostramp.com/api/keyword.php?func=getTotalKeywordsByUser

Parameters

  • (GET) token (int, required): Your API session token