Skip to main content
This guide will get you all set up and ready to use the LibFrog API. We will cover how to get started and how to make your first API request to search NFL game transcripts.

​
Get your API key

First, you will need to generate an API key. You can do this from your LibFrog dashboard or by calling the generateApiKey Firebase function.
1

Sign In

Log in to your LibFrog account (or create one if you don’t have an account)
2

Go to Settings

Navigate to Settings and find the API settings section
3

Generate API Key

Click “Generate New API Key”
4

Save Your Key

Copy and securely store your API key - you’ll need it for all requests

​
Making your first API request

After you have your API key, you are ready to make your first call to the LibFrog API. Below, you can see how to send a GET request to the Search NFL Strike Word endpoint to search for a phrase in NFL game transcripts. 
curl "https://us-central1-mentionmarket-dddf0.cloudfunctions.net/searchNFLStrikeWord?target_phrase=%22what%20a%20catch%22&apiKey=YOUR_KEY"

​
Understanding the Response

The API returns a JSON object with statistical information about phrase occurrences:
Example Response
{
  "total_games_checked": 1250,
  "games_with_phrase": 45,
  "probability": 0.036,
  "cached": false
}
The response includes:
  • total_games_checked: Total number of games analyzed
  • games_with_phrase: Number of games containing your phrase
  • probability: Likelihood of the phrase occurring (0-1)
  • cached: Whether results were served from cache (cached for 1 week)

​
What’s next?

Great! You are now set up with an API key and have made your first request to the API. Here are a few links that might be handy as you venture further into the LibFrog API:

Authentication

Learn more about API keys and security

Search Endpoint

Explore the full Search endpoint documentation