PayPerQ Logo

PayPerQ

API
Data Providers
  • X/Twitter
  • Google Maps
  • FullEnrich
  • Minerva
  • Exa
  • Firecrawl
  • Clado
  • Serper
  • Reddit
  • Whitepages
  • Hunter

Data API Reference

39 endpoints across 11 providers — all accessible via your PPQ API key at https://api.ppq.ai/v1/data

Each call deducts from your PPQ credit balance. Authentication: Authorization: Bearer YOUR_API_KEY

People Search is also available as a no-code chat tool — starting at ~25¢ per query. It searches the web and these data endpoints to find people at a company or look up a specific person.

X/Twitter

Real-time X/Twitter data — search tweets, look up users, browse lists, communities, and more.

GET/x/tweets/search$0.01

Tweet Search

Search tweets with advanced filters: keywords, phrase matching, hashtags, user filters, engagement minimums, and date ranges.

Parameters

wordsoptionalAll these words must appear
phraseoptionalExact phrase match
anyWordsoptionalAny of these words
noneWordsoptionalExclude these words
hashtagsoptionalFilter by hashtag
fromoptionalTweets from this username
tooptionalTweets replying to this username
mentioningoptionalTweets mentioning this username
minRepliesoptionalMinimum reply count
minLikesoptionalMinimum like count
minRepostsoptionalMinimum retweet count
sinceoptionalStart date (YYYY-MM-DD)
untiloptionalEnd date (YYYY-MM-DD)
next_tokenoptionalPagination cursor

Use case: Monitor conversations, track trends, or find tweets matching specific criteria.

At least one search parameter is required. Returns up to 20 tweets per page.

GET/x/tweets/by/id$0.01

Tweet by ID

Retrieve a specific tweet by its ID with full metadata and engagement metrics.

Parameters

idrequiredTweet ID

Use case: Get full details for a specific tweet.

GET/x/tweets/user$0.01

User Tweets

Get a user's recent tweets with engagement metrics.

Parameters

usernamerequiredTwitter/X username (without @)
next_tokenoptionalPagination cursor

Use case: Browse a user's tweet timeline.

GET/x/tweets/replies$0.01

Tweet Replies

Get replies to a specific tweet.

Parameters

idrequiredTweet ID
next_tokenoptionalPagination cursor

Use case: Read the conversation thread under a tweet.

GET/x/tweets/quote_tweets$0.01

Quote Tweets

Get quote tweets of a specific tweet.

Parameters

idrequiredTweet ID
next_tokenoptionalPagination cursor

Use case: See how people are quoting and commenting on a tweet.

GET/x/tweets/retweeted_by$0.01

Retweeted By

Get users who retweeted a specific tweet.

Parameters

idrequiredTweet ID
next_tokenoptionalPagination cursor

Use case: Identify who is amplifying a tweet.

GET/x/users/search$0.01

User Search

Search for X/Twitter users by keyword.

Parameters

queryrequiredSearch query
next_tokenoptionalPagination cursor

Use case: Find users matching specific criteria.

GET/x/users/by/id$0.01

User by ID

Look up a user by their numeric ID.

Parameters

idrequiredUser ID

Use case: Get user profile details from an ID.

GET/x/users/by/username$0.01

User by Username

Look up a user by their @username.

Parameters

usernamerequiredTwitter/X username (without @)

Use case: Get user profile details from a handle.

GET/x/users/followers$0.01

User Followers

Get a user's followers.

Parameters

idrequiredUser ID
next_tokenoptionalPagination cursor

Use case: Analyze follower base of an account.

GET/x/users/following$0.01

User Following

Get accounts a user is following.

Parameters

idrequiredUser ID
next_tokenoptionalPagination cursor

Use case: See who an account follows for network analysis.

GET/x/lists/by/id$0.01

List by ID

Get details for a specific X/Twitter list.

Parameters

idrequiredList ID

Use case: Look up list metadata.

Google Maps

Search and retrieve place data powered by Google Maps.

POST/api/google-maps/text-search/full$0.08

Text Search (Full)

Search for places using a text query with full details including ratings, reviews, contact info, and atmosphere data.

Parameters

textQueryrequiredSearch query string
maxResultCountoptionalMaximum number of results to return
pageTokenoptionalToken for paginating through results

Use case: Find businesses, landmarks, or points of interest with complete information.

POST/api/google-maps/text-search/partial$0.02

Text Search (Partial)

Search for places using a text query, returning basic fields only (name, address, location). Lower cost alternative to the full version.

Parameters

textQueryrequiredSearch query string
maxResultCountoptionalMaximum number of results to return
pageTokenoptionalToken for paginating through results

Use case: Get a list of matching places when you only need names and addresses.

POST/api/google-maps/nearby-search/full$0.08

Nearby Search (Full)

Find places near a geographic coordinate with full details.

Parameters

locationRestrictionrequiredCircle with center (lat/lng) and radius in meters
maxResultCountoptionalMaximum number of results to return

Use case: Discover all restaurants, shops, or services within a given radius of a location.

POST/api/google-maps/nearby-search/partial$0.02

Nearby Search (Partial)

Find places near a geographic coordinate, returning basic fields only.

Parameters

locationRestrictionrequiredCircle with center (lat/lng) and radius in meters
maxResultCountoptionalMaximum number of results to return

Use case: Get a list of nearby places when you only need names and locations.

GET/api/google-maps/place-details/full$0.05

Place Details (Full)

Retrieve complete details for a specific place by its Google Place ID.

Parameters

placeIdrequiredGoogle Place ID for the location

Use case: Get all available data for a known place — hours, phone, website, reviews, and more.

GET/api/google-maps/place-details/partial$0.02

Place Details (Partial)

Retrieve basic details for a specific place by its Google Place ID.

Parameters

placeIdrequiredGoogle Place ID for the location

Use case: Get essential place info (name, address, coordinates) for a known Place ID at lower cost.

GET/api/google-maps/solar/building-insights$0.02

Solar Building Insights

Get rooftop solar potential for the closest building to a coordinate, including imagery date.

Parameters

latituderequiredLatitude of the location
longituderequiredLongitude of the location
requiredQualityoptionalMinimum imagery quality (e.g. "HIGH")

Use case: Estimate rooftop solar viability and panel capacity for a property.

GET/api/google-maps/solar/data-layers$0.08

Solar Data Layers

Get aerial GeoTIFF solar data layers (RGB, DSM, flux) for an area, with imagery date.

Parameters

latituderequiredLatitude of the location
longituderequiredLongitude of the location
radiusMetersoptionalRadius of the area to cover, in meters
viewoptionalWhich layers to return
requiredQualityoptionalMinimum imagery quality
pixelSizeMetersoptionalPixel resolution in meters

Use case: Build detailed solar analyses with raw rooftop elevation and flux layers.

GET/api/google-maps/solar/rgb-image$0.05

Solar RGB Image

Render a solar GeoTIFF layer (RGB, DSM, flux, shade, or mask) as a PNG/JPEG and return its URL.

Parameters

idoptionalA GeoTIFF id (alternative to latitude/longitude)
latitudeoptionalLatitude (alternative to id)
longitudeoptionalLongitude (alternative to id)
layeroptionalLayer to render: rgb, dsm, flux, shade, or mask
monthoptionalMonth for monthlyFlux (single or 4x3 grid)
houroptionalHour for hourlyShade (single or 6x4 grid)
formatoptionalOutput image format (PNG or JPEG)

Use case: Produce a shareable image of a rooftop solar layer for reports or UIs.

GET/api/google-maps/aerial-view/lookup-video$0.01

Aerial View Lookup

Look up a previously rendered aerial flyover video by address or video ID.

Parameters

addressoptionalAddress to look up (alternative to videoId)
videoIdoptionalVideo ID returned from a render request

Use case: Retrieve a completed aerial flyover video once rendering has finished.

Pair with the render endpoint: request a render, then poll this lookup until the video is ready.

POST/api/google-maps/aerial-view/render-video$0.01

Aerial View Render

Request rendering of a new aerial flyover video for an address.

Parameters

addressrequiredAddress to render an aerial flyover for

Use case: Kick off an aerial flyover video; retrieve it later via the lookup endpoint.

Rendering is asynchronous — use Aerial View Lookup to fetch the finished video.

FullEnrich

B2B contact and company data for sales prospecting.

POST/api/fullenrich/people-search$0.05

People Search

Search for people/contacts by company domain, seniority, title, location, and skills. Returns full contact records directly — no separate unlock step required.

Parameters

current_company_domainsoptionalArray of { value } company domains, e.g. [{ "value": "stripe.com" }]
current_position_seniority_leveloptionalArray of { value } seniority enums (C-level, VP, Head, Founder) — prefer over titles for population queries
current_position_titlesoptionalArray of { value } exact titles — far fewer results than seniority
person_locationsoptionalArray of { value } locations — pair with a company domain, location alone is very broad
limitoptionalMax people to return (default 3, flat price regardless)
search_afteroptionalCursor token from metadata.search_after for pagination

Use case: Build a targeted contact list — e.g. all VPs at a given company domain. Start with domain + seniority; adding 3+ filters often returns zero.

Use FullEnrich seniority enums (C-level, VP, Head, Founder) — Apollo-style values like c_suite return 400.

POST/api/fullenrich/company-search$0.05

Company Search

Search for companies by legal entity name, industry, headcount, or HQ location.

Parameters

namesoptionalArray of { value } legal entity names (e.g. Anysphere, not Cursor)
industriesoptionalArray of { value } FullEnrich industry enum strings (e.g. Software Development)
headquarters_locationsoptionalArray of { value } HQ locations (e.g. United States)
headcountsoptionalArray of { min?, max? } employee-count ranges
limitoptionalMax companies to return (default 3)
search_afteroptionalCursor token from metadata.search_after for pagination

Use case: Find and verify target companies and their domains before running people searches.

Provide at least one of names, industries, or headquarters_locations — limit/page alone returns 400.

POST/api/pdl/people-enrich$0.20

People Enrich

Resolve a single person to their full career history, emails, and phone numbers.

Parameters

emailoptionalEmail address — highest-reliability input; prefer when known
profileoptionalLinkedIn or other social profile URL
first_nameoptionalFirst name (pair with last_name + company_name or company_domain)
last_nameoptionalLast name
company_nameoptionalCompany name (with first_name + last_name)
company_domainoptionalCompany domain (with first_name + last_name)

Use case: Get complete, actionable contact information for a known individual. Provide at least one identifier; email gives the most reliable match.

A no-match lookup returns HTTP 404. Prefer email > profile > name+domain.

POST/api/companyenrich/org-enrich$0.06

Organization Enrich

Get a comprehensive company profile — size, revenue, industry, and more — by domain.

Parameters

domainrequiredCompany website domain (e.g. "stripe.com")
expandoptionalOptional workforce breakdown (costs extra upstream credits)

Use case: Research a company in depth by its domain — headcount and revenue ranges, industry, and firmographics.

employees/revenue are returned as range strings. Verify the returned domain matches your input.

POST/api/companyenrich/properties-enrich$0.06

Enrich by Properties

Match and enrich a company by name or social URL when the domain is unknown, returning a full profile.

Parameters

nameoptionalCompany name (best-match disambiguation)
linkedinUrloptionalLinkedIn company page URL
twitterUrloptionalTwitter/X company URL
facebookUrloptionalFacebook company URL
instagramUrloptionalInstagram company URL
expandoptionalOptional workforce breakdown (costs extra upstream credits)

Use case: Enrich a company you only know by name or social profile, without a domain.

Best-match disambiguation — verify the returned domain before downstream people searches.

Minerva

Identity resolution and people enrichment — resolve, enrich, and validate person records at scale.

POST/api/minerva/resolve$0.02

Resolve

Resolve person records to a Minerva PID and LinkedIn URL, with fuzzy and reverse lookup support.

Parameters

recordsrequiredArray of person records to resolve (max 1000 per request)
match_condition_fieldsoptionalFields that must be present for a match (e.g. "minerva_pid", "linkedin_url")

Use case: Map raw names/emails/phones to stable Minerva identities before enrichment.

POST/api/minerva/enrich$0.05

Enrich

Enrich person records with demographics, work history, education, contact info, addresses, and financial signals.

Parameters

recordsrequiredArray of person records to enrich (max 500 per request)
match_condition_fieldsoptionalFields that must be present for a match
return_fieldsoptionalFields to return beyond base fields (omit to return all)

Use case: Build full person profiles by Minerva PID, LinkedIn URL, or name/email/phone.

POST/api/minerva/validate-emails$0.01

Validate Emails

Check whether email addresses exist in the Minerva database and get validation status and last-seen timestamps.

Parameters

recordsrequiredArray of email address strings to validate (max 2000 per request)

Use case: Validate and prioritize a list of email addresses before outreach.

Exa

Neural web search — find and extract web content semantically.

POST/api/exa/search$0.01

Search

Semantic web search that finds the most relevant pages for a query. Supports filtering by content category.

Parameters

queryrequiredSearch query
numResultsoptionalNumber of results (up to 100)
categoryoptionalFilter by type: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report

Use case: Find relevant web pages, LinkedIn profiles, research papers, or news articles on any topic.

POST/api/exa/find-similar$0.01

Find Similar

Find web pages that are semantically similar to a given URL.

Parameters

urlrequiredURL to find similar pages for
numResultsoptionalNumber of results to return

Use case: Competitive research — find similar companies, articles, or resources to a known URL.

POST/api/exa/contents$0.002

Contents

Extract and return the text content from a list of URLs. The cheapest bulk extraction option.

Parameters

urlsrequiredArray of URLs to extract content from

Use case: Bulk extraction of web page text when cost is a priority.

POST/api/exa/answer$0.01

Answer

Get an AI-generated answer to a question, grounded in live web search results.

Parameters

queryrequiredQuestion to answer

Use case: Get a direct, sourced answer to a factual question without manually reviewing search results.

Firecrawl

Web scraping with clean markdown output.

POST/api/firecrawl/scrape$0.01

Scrape

Scrape a web page and return its content as clean, formatted markdown. Handles JavaScript-rendered pages.

Parameters

urlrequiredURL of the page to scrape

Use case: Extract full page content from any URL with clean, LLM-ready markdown output.

POST/api/firecrawl/search$0.03

Search

Search the web and return pre-scraped full content for each result.

Parameters

queryrequiredSearch query
limitoptionalMaximum number of results to return

Use case: Web search that returns full page content (not just snippets) for each result.

Clado

LinkedIn profile and contact enrichment.

POST/api/clado/contacts-enrich$0.20

Contacts Enrich

Enrich contact information from a LinkedIn URL, email address, or phone number. Returns personal emails, phone numbers, and profile data.

Parameters

linkedin_urloptionalLinkedIn profile URL (provide exactly one of the three identifiers)
emailoptionalEmail address
phoneoptionalPhone number

Use case: Get personal contact details for a prospect, especially when people-search lacks direct emails or phone numbers for newer accounts.

Provide exactly one of: linkedin_url, email, or phone.

Serper

Google Search results via Serper.dev.

POST/api/serper/news$0.04

News Search

Search Google News for recent articles and news coverage on any topic.

Parameters

qrequiredSearch query
numoptionalNumber of results to return
gloptionalCountry code for localized results (e.g. "us")
hloptionalLanguage code (e.g. "en")

Use case: Monitor news coverage about a company, person, or topic.

POST/api/serper/shopping$0.04

Shopping Search

Search Google Shopping for product listings with prices and seller information.

Parameters

qrequiredProduct search query
numoptionalNumber of results to return
gloptionalCountry code for localized results
hloptionalLanguage code

Use case: Product research, price comparison, and market intelligence.

POST/api/serper/images$0.04

Images Search

Search Google Images for pictures matching a query.

Parameters

qrequiredSearch query
numoptionalNumber of results to return
gloptionalCountry code for localized results (e.g. "us")
hloptionalLanguage code (e.g. "en")
locationoptionalLocation (e.g. "New York, NY")

Use case: Find images for a topic, product, or brand.

POST/api/serper/people-image-search$0.04

People Image Search

Google Images search tuned for finding photos/headshots of a specific person.

Parameters

qrequiredExact-name + company/context query, e.g. '"Jane Doe" "Acme" headshot'
numoptionalNumber of results to return
gloptionalCountry code for localized results
hloptionalLanguage code
locationoptionalLocation (e.g. "New York, NY")

Use case: Find a headshot for a known person; resolve their company/title first for ambiguous names.

POST/api/serper/lens$0.20

Lens Reverse Image Search

Reverse-image search a public image URL with Google Lens.

Parameters

urlrequiredPublic URL of the image to reverse-search
gloptionalCountry code for localized results
hloptionalLanguage code

Use case: Identify the source, subject, or similar images for a given picture.

Reddit

Search Reddit posts and retrieve full thread discussions.

POST/api/reddit/search$0.02

Search

Search Reddit posts by query. Returns post previews with selftext truncated to 500 characters.

Parameters

queryrequiredSearch query
sortoptionalSort order: relevance, hot, top, new, comments
timeframeoptionalTime filter: hour, day, week, month, year, all
maxResultsoptionalMaximum number of posts to return

Use case: Discover Reddit discussions about a topic, product, or question.

selftext is truncated to 500 characters. Use the post-comments endpoint to fetch full content of specific posts.

POST/api/reddit/post-comments$0.02

Post Comments

Retrieve the full post content and all comments for a specific Reddit post by its URL.

Parameters

urlrequiredReddit post permalink URL

Use case: Deep-dive into a specific Reddit thread to read full discussions and community sentiment.

Two-step pattern: use the search endpoint first to find relevant posts, then use this to read full content.

Whitepages

US people and property records.

POST/api/whitepages/person-search$0.22

Person Search

Look up a person by name and location. Returns contact information, address history, and associated people.

Parameters

first_namerequiredFirst name of the person
last_namerequiredLast name of the person
state_coderequired2-letter US state abbreviation (e.g. "CA")

Use case: Background checks, people locating, and contact verification for US individuals.

Use state_code (2-letter abbreviation), not "state".

POST/api/whitepages/property-search$0.22

Property Search

Look up property ownership, current residents, and property details by address.

Parameters

streetrequiredStreet address (e.g. "123 Main St")
cityrequiredCity name
state_coderequired2-letter US state abbreviation (e.g. "CA")

Use case: Real estate research, property ownership verification, and skip tracing.

Use state_code (2-letter abbreviation), not "state".

Hunter

Email verification and deliverability checking.

POST/api/hunter/email-verifier$0.03

Email Verifier

Verify an email address for deliverability. Returns status (valid, invalid, risky, unknown), SMTP check results, and mail server details.

Parameters

emailrequiredEmail address to verify

Use case: Clean email lists, validate contacts before outreach, and reduce bounce rates.

For authentication, credit topups, and other API endpoints, see the API documentation →