Getting Started

Copy page

Getting Started with Open Paws API

Welcome to the Open Paws API! This guide will help you start using our platform for animal advocacy research and campaign management.

What You Can Do

The Open Paws API provides access to:

• Campaigns - Advocacy campaigns with goals, talking points, and target information
• Actions - Specific actions users can take (emails, calls, social media posts)
• Public Figures - Politicians, celebrities, and influencers with alignment rankings
• Organizations - Companies, NGOs, and advocacy groups
• Content - Social media posts and articles relevant to animal advocacy
• Suggestions - AI-generated advocacy messaging suggestions

Authentication

All API requests require an API key. Get your free API key:

Your API key will be created and ready to use. Include it in your requests using the Authorization header:

Code
 
Authorization: Bearer YOUR_API_KEY

Your First Request

Let's search for animal welfare campaigns. Click the button below to try it in the API Playground:

Try: Search Campaigns

Example request body:

Code
 
{
  "query": "factory farming",
  "search_type": "text",
  "limit": 10
}

Example response:

Code
 
{
  "table": "campaigns",
  "search_type": "text",
  "query": "factory farming",
  "total": 25,
  "limit": 10,
  "offset": 0,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "End Factory Farming Act",
      "description": "Campaign to pass federal legislation...",
      "goal": "Pass HR 1234 by end of 2025",
      "status": "active",
      "cause_areas": ["animal_welfare", "environment"],
      "country_codes": ["US"]
    }
  ]
}

Search Types

Text Search (Default)

Fast keyword-based search across relevant fields. Best for specific terms and names.

Code
 
{
  "query": "cage-free eggs",
  "search_type": "text"
}

Semantic Search

AI-powered conceptual search using embeddings. Finds results based on meaning, not just keywords. Costs 5x more than text search.

Code
 
{
  "query": "improving conditions for farm animals",
  "search_type": "semantic"
}

Searchable Tables

Table	Description	Example Filters
campaigns	Advocacy campaigns	status, cause_areas, country_codes
actions	User actions (emails, calls)	action_type, platform, target_type
public_figures	Politicians & influencers	party, country_code, figure_type
organizations	Companies & NGOs	industry, org_type, country_codes
content	Social media & articles	platform, stance, content_type
suggestions	AI-generated messages	tone, approach, audience

Using Filters

Narrow your search results with filters:

Code
 
{
  "query": "animal welfare",
  "search_type": "text",
  "filters": {
    "status": "active",
    "country_codes": ["US", "UK"]
  },
  "limit": 20
}

Search All Tables

Search across all tables at once with /search/all:

Try: Search All Tables

Code
 
{
  "query": "animal testing cosmetics",
  "search_type": "text",
  "limit_per_table": 5
}

Rate Limits & Pricing

Plan	Rate Limit	Monthly Quota	Cost
Free	1 req/hour	5 requests	$0
Pay As You Go	50 req/hour	Unlimited	Usage-based

Endpoint Pricing (Pay As You Go)

Endpoint	Text Search	Semantic Search
/search/{table}	$0.05	$0.25
/search/all	$0.15	$0.75
/osint/personal-profile	$1.50	-

See Pricing for more details.

Next Steps

• Explore the API Reference for complete endpoint documentation
• Check out Pricing to upgrade your plan
• Manage your API Keys or Billing