PayPerQ Logo

PayPerQ

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

Data API Reference

27 endpoints across 10 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

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.

Apollo

B2B contact and company data for sales prospecting.

POST/api/apollo/people-search$0.02

People Search

Search for people matching criteria such as job title, location, or keywords. Returns obfuscated names that must be enriched with the people-enrich endpoint to reveal full contact details.

Parameters

q_keywordsoptionalKeywords to filter by (name, title, company)
person_locationsoptionalArray of location strings to filter by
per_pageoptionalResults per page (default 25)
pageoptionalPage number for pagination

Use case: Find a list of professionals matching your target profile before enriching for contact details.

Results have obfuscated names. Always follow up with people-enrich to reveal full information.

POST/api/apollo/org-search$0.02

Organization Search

Search for companies by keywords, location, or industry to find and verify organization IDs.

Parameters

q_keywordsoptionalKeywords to filter companies by
organization_locationsoptionalArray of location strings
per_pageoptionalResults per page

Use case: Verify exact organization identifiers and domains before using them in people searches.

POST/api/apollo/people-enrich$0.05

People Enrich

Reveal full contact details for a person — unobfuscated name, email, phone, and profile data.

Parameters

emailrequiredEmail address of the person to enrich

Use case: Get complete, actionable contact information for individuals found via people-search.

Required follow-up step after people-search to access real names and contact details.

POST/api/apollo/org-enrich$0.05

Organization Enrich

Get a comprehensive company profile including size, funding, industry, and tech stack by domain.

Parameters

domainrequiredCompany website domain (e.g. "acme.com")

Use case: Research a company in depth — headcount, funding rounds, technology used, and key contacts.

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 Apollo lacks direct emails or phone numbers for newer accounts.

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

POST/api/clado/linkedin-scrape$0.04

LinkedIn Scrape

Scrape a full LinkedIn profile including work experience, education, skills, and recent posts.

Parameters

linkedin_urlrequiredLinkedIn profile URL to scrape

Use case: Get a comprehensive view of a person's professional background from their LinkedIn profile.

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.

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.44

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.44

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.

Influencer

Social media profile enrichment and influencer discovery.

POST/api/influencer/enrich-by-email$0.40

Enrich by Email

Find and enrich social media profiles associated with an email address.

Parameters

emailrequiredEmail address to look up
platformrequiredPlatform to search: instagram, tiktok, youtube, facebook
enrichment_modeoptionalEnrichment depth (e.g. "enhanced")

Use case: Discover a person's social media presence and influence from their email address.

POST/api/influencer/enrich-by-social$0.40

Enrich by Social

Get a comprehensive influencer profile including follower counts, engagement metrics, and contact information from a social handle.

Parameters

platformrequiredPlatform: instagram, tiktok, youtube, facebook
usernamerequiredSocial media username/handle
enrichment_modeoptionalEnrichment depth (e.g. "enhanced")
email_requiredoptionalWhether to require email in the response

Use case: Research influencer reach and get contact details for outreach campaigns.

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