The Piloterr connector lets your AI agent act in each user's Piloterr account. Each user connects their own Piloterr API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 60 · 0 · 060 read0 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Piloterr connection
In AgentKit > Connections, create a Piloterr connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'piloterr'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Piloterr:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'piloterr_crunchbase_company_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "piloterr"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Piloterr:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="piloterr_crunchbase_company_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Piloterr credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpiloterr_amazon_product_getGet an Amazon product by ASIN on a chosen marketplace.Read-onlyGet Amazon Product
Get an Amazon product by ASIN on a chosen marketplace. Returns JSON with url, asin, image, price, stock, title, coupon, images, currency, features, and more. Use piloterr_amazon_search to find ASINs. Costs 1 credit.
Inputs
querystringrequired- Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for. Example: B09DFCB66S.
domainstring- Amazon domain extension to query. Controls which Amazon marketplace is targeted: com (Amazon United States (default)), fr (Amazon France), de (Amazon Germany), co.uk (Amazon United Kingdom), it (Amazon Italy), es (Amazon Spain), ca (Amazon Canada), co.jp... Example: com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_amazon_searchSearch Amazon products by keyword on a chosen marketplace (up to 60 results per page).Read-onlySearch Amazon
Search Amazon products by keyword on a chosen marketplace (up to 60 results per page). Returns a JSON array of items with url, asin, price, title, rating, real_price, reviews_count. Use piloterr_amazon_product_get with an ASIN for full details. Costs 1 credit.
Inputs
querystringrequired- Keyword or phrase to search for products on Amazon. Example: playstation 5.
domainstring- Amazon domain extension to query. Controls which Amazon marketplace is searched: com (Amazon United States (default)), fr (Amazon France), de (Amazon Germany), co.uk (Amazon United Kingdom), it (Amazon Italy), es (Amazon Spain), ca (Amazon Canada), co.jp... Example: com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number for paginated search results. Each page returns up to 60 results. Example: 1.
piloterr_arxiv_searchSearch arXiv papers by keyword, fielded query (au:einstein) or arXiv ID.Read-onlySearch arXiv
Search arXiv papers by keyword, fielded query (au:einstein) or arXiv ID. Returns JSON with results, pagination. Use this for academic literature search. Costs 1 credit.
Inputs
querystringrequired- Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers.
piloterr_bing_searchRun a Bing web search with location, coordinates, market and country options.Read-onlySearch Bing
Run a Bing web search with location, coordinates, market and country options. Returns JSON with pagination, organic_results, search_parameters, search_information. Use this as an alternative to piloterr_google_search. Costs 1 credit.
Inputs
querystringrequired- The search query to execute on Bing. Supports all Bing advanced search operators. Example: openai.
ccstring- Two-letter ISO 3166-1 country code defining the country to search from: us (United States), de (Germany), gb (United Kingdom), fr (France). Example: us.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
latnumber- GPS latitude coordinate for the search origin. Example: 48.8566.
locationstring- City or region from which the search should originate. If multiple locations match, the most popular one is selected. Example: Austin.
lonnumber- GPS longitude coordinate for the search origin. Example: 2.3522.
mktstring- Market code combining language and country, in the form <language>-<country>. Defines where the results come from: en-US (English, United States (default)), fr-FR (French, France), de-DE (German, Germany), es-ES (Spanish, Spain). Example: en-US.
numinteger- Number of results per page. Minimum: 10, Maximum: 50. Example: 20.
pageinteger- Page number of results to retrieve. Used for pagination: 1 (First page (default)), 2 (Second page), 3 (Third page, etc). Example: 1.
piloterr_company_getGet firmographic data for a company from its domain: name, industries, staff range, revenue, location, founding year and phone.Read-onlyGet Company By Domain
Get firmographic data for a company from its domain: name, industries, staff range, revenue, location, founding year and phone. Returns JSON with name, domain, founded, revenue, location, domain_tld, industries, updated_at, description, domain_name, and more. Use this as the general company lookup. Use the LinkedIn, Crunchbase, Owler or PitchBook tools for source-specific profiles. Costs 1 credit.
Inputs
querystringrequired- The domain name of the company to look up. Accepts multiple formats: gucci.com (bare domain name), https://gucci.com (full URL format). Example: gucci.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_crunchbase_company_getGet a Crunchbase organization profile by name, permalink, UUID or URL, or by reverse lookup from a domain.Read-onlyGet Crunchbase Company
Get a Crunchbase organization profile by name, permalink, UUID or URL, or by reverse lookup from a domain. Returns JSON with logo, name, tags, uuid, aliases, founded, website, headline, location, permalink, and more. Use piloterr_crunchbase_search when you are not sure of the company identifier. Costs 2 credits.
Inputs
domainstring- Perform a reverse lookup by domain name to find the associated Crunchbase company profile. Example: piloterr.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
querystring- Search for a company by its name, permalink, or full Crunchbase URL: openai (Search by company name or slug), e8faa410-c307-482b-a389-74c6507ed242 (Search by UUID), https://www.crunchbase.com/organization/openai (Full Crunchbase organization URL). Example: openai.
piloterr_crunchbase_funding_round_getGet one Crunchbase funding round by permalink, with investors, amount and press timeline.Read-onlyGet Crunchbase Funding Round
Get one Crunchbase funding round by permalink, with investors, amount and press timeline. Returns JSON with uuid, cards, value, image_id, permalink, entity_def_id, num_investors, overview_fields_v2. Use piloterr_crunchbase_funding_rounds_list to find rounds. Costs 2 credits.
Inputs
querystringrequired- The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL. Example: openai-secondary-market--3bab6e98.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_crunchbase_funding_rounds_listList recent Crunchbase funding rounds filtered by days since announcement, round type, investor or funded organization (up to 15 per call).Read-onlyList Crunchbase Funding Rounds
List recent Crunchbase funding rounds filtered by days since announcement, round type, investor or funded organization (up to 15 per call). Returns JSON with total, results. Use piloterr_crunchbase_funding_round_get for one round's details. Costs 2 credits.
Inputs
days_since_announcementinteger- Only rounds announced within the last N days. At most 15 results come back per call; combine with investment_type to narrow. Example: 30.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
funded_organization_identifierstring- Filter rounds by a specific funded organization using their Crunchbase UUID. Example: cf2c678c-b81a-80c3-10d1-9c5e76448e51.
investment_typestring- Filter by funding round type, for example pre_seed, seed, series_a to series_j, series_unknown, angel, private_equity, debt_financing, convertible_note, grant, corporate_round, secondary_market, post_ipo_equity or undisclosed. Example: series_a.
investor_identifiersstring- Filter rounds by a specific investor using their Crunchbase UUID. Example: df14597c-3e51-8d58-9c15-fb3de3a34a54.
piloterr_crunchbase_person_getGet a Crunchbase person profile by name, permalink or URL, with career history, investments and board roles.Read-onlyGet Crunchbase Person
Get a Crunchbase person profile by name, permalink or URL, with career history, investments and board roles. Returns JSON with logo, name, uuid, title, gender, image_id, education, facet_ids, locations, permalink, and more. Use piloterr_crunchbase_search to find the permalink first. Costs 2 credits.
Inputs
querystringrequired- Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL: alex-martin (Search by permalink slug), https://www.crunchbase.com/person/alex-martin (Full Crunchbase person URL), Jordan Lee (Search by full name). Example: alex-martin.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_crunchbase_searchSearch Crunchbase organizations and people by keyword.Read-onlySearch Crunchbase
Search Crunchbase organizations and people by keyword. Returns JSON with results. Use this to find permalinks for piloterr_crunchbase_company_get and piloterr_crunchbase_person_get. Costs 2 credits.
Inputs
querystringrequired- The search keyword or phrase to query across Crunchbase. Searches both organizations and people. Example: openai.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_domain_dnsbl_checkCheck whether a domain or IP address is listed on DNS-based blacklists (DNSBL), per provider.Read-onlyCheck DNS Blacklists
Check whether a domain or IP address is listed on DNS-based blacklists (DNSBL), per provider. Returns JSON with address, detected, providers, blacklisted. Use this for email deliverability and reputation checks. Costs 1 credit.
Inputs
querystringrequired- A domain name or IP address to check against DNS-based blacklists (DNSBL). Example: 185.122.10.10.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_domain_malicious_checkCheck whether a domain or IP address is flagged as malicious by threat-intelligence feeds.Read-onlyCheck Malicious Domain
Check whether a domain or IP address is flagged as malicious by threat-intelligence feeds. Returns JSON with sources, malicious. Use this for security screening. Use piloterr_domain_dnsbl_check for email blacklists. Costs 1 credit.
Inputs
querystringrequired- A domain name or IP address to check for malicious activity across multiple threat intelligence sources. Example: 197.33.189.70.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_domain_whois_getGet WHOIS registration data for a domain.Read-onlyGet Domain WHOIS
Get WHOIS registration data for a domain. Returns JSON with domain, registrar, technical, registrant, administrative. Use this to see who registered a domain and when it expires. Costs 1 credit.
Inputs
querystringrequired- A domain name for which you want to retrieve WHOIS registration information. Example: piloterr.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_duckduckgo_searchRun a DuckDuckGo web search with country and language options.Read-onlySearch DuckDuckGo
Run a DuckDuckGo web search with country and language options. Returns JSON with organic_results, search_parameters. Use this as an alternative to piloterr_google_search. Costs 1 credit.
Inputs
querystringrequired- Search query sent to DuckDuckGo Search. Example: open source vector database.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
glstring- Country code, for example us, fr, gb, de, jp. Example: us.
hlstring- Language code, for example en, fr, de, ja, zh. Example: en.
pageinteger- Page number. Page 1 is the first page of results. Example: 1.
piloterr_ebay_searchSearch eBay listings by keyword or eBay search URL.Read-onlySearch eBay
Search eBay listings by keyword or eBay search URL. Returns JSON with results, pagination. Costs 3 credits per call.
Inputs
querystringrequired- Keyword on www.ebay.com, or a search URL on a supported eBay site. Example: laptop.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400. Example: 1.
return_page_sourceboolean- When true, return raw HTML. Example: false.
piloterr_email_findFind a person's verified professional email address from their full name and company domain or name.Read-onlyFind Professional Email
Find a person's verified professional email address from their full name and company domain or name. Returns JSON with email, status, last_name, first_name, company_domain. Use piloterr_email_verify to check an address you already have. Costs 1 credit.
Inputs
querystringrequired- Full name of the person whose professional email address you want to find. Example: Alex Martin.
company_domainstring- The company's domain name. Multiple formats are accepted: piloterr.com (Bare domain (preferred)), https://www.piloterr.com (Full URL format). Example: piloterr.com.
company_namestring- The company name of the person you are looking for. Example: Piloterr.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_email_infrastructure_analyzeAnalyze a domain's email infrastructure: Microsoft 365 or Google Workspace use, SPF and DNS setup.Read-onlyAnalyze Email Infrastructure
Analyze a domain's email infrastructure: Microsoft 365 or Google Workspace use, SPF and DNS setup. Returns JSON with domains, is_microsoft_365, is_google_workspace, microsoft_365_domains, google_workspace_domains. Use this to learn which email provider a company uses. Costs 1 credit.
Inputs
querystringrequired- The domain name you want to analyze for email infrastructure. Example: airbus.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_email_verifyCheck whether an email address is valid and deliverable.Read-onlyVerify Email
Check whether an email address is valid and deliverable. Returns JSON with email, status. Use this before sending to an address. Use piloterr_email_find to discover an address. Costs 1 credit.
Inputs
querystringrequired- The email address you want to verify. Example: name@example.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_g2_product_getGet a G2 product reviews page by slug or URL: rating, pricing, categories, alternatives and reviews.Read-onlyGet G2 Product
Get a G2 product reviews page by slug or URL: rating, pricing, categories, alternatives and reviews. Returns JSON with rating, reviews, what_is, category, breadcrumb, categories, company_id, is_claimed, product_id, screenshots, and more. Use nps_score to keep only reviews with one star rating. Costs 2 credits.
Inputs
querystringrequired- Product slug or a www.g2.com product URL. Example: postman.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
nps_scoreinteger- Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page. Example: 5.
return_page_sourceboolean- Return the rendered HTML instead of the parsed product. Example: false.
piloterr_github_user_getGet a public GitHub user profile by profile URL, username or email.Read-onlyGet GitHub User
Get a public GitHub user profile by profile URL, username or email. Returns JSON with id, name, email, login, company, gist_url, gpg_keys, location, ssh_keys, followers, and more. Use this for developer research. Costs 1 credit.
Inputs
querystringrequired- GitHub profile URL, username or email address. Example: https://github.com/example-user.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_glassdoor_company_getGet a Glassdoor company profile by URL or employer ID.Read-onlyGet Glassdoor Company
Get a Glassdoor company profile by URL or employer ID. Returns JSON with url, name, size, domain, rating, founded, revenue, website, industry, logo_url, and more. Use this for employer ratings, size and industry. Costs 2 credits.
Inputs
querystringrequired- Glassdoor company URL or employer ID. Example: 1692882.
domainstring- Glassdoor TLD when query is not a full URL. Example: com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_glassdoor_jobs_searchSearch Glassdoor job listings by keyword or search URL.Read-onlySearch Glassdoor Jobs
Search Glassdoor job listings by keyword or search URL. Returns JSON with results, pagination. Page with page. Use piloterr_linkedin_jobs_search for LinkedIn. Costs 2 credits.
Inputs
querystringrequired- Keyword or full Glassdoor job search URL. Example: data engineer.
domainstring- Glassdoor TLD when query is not a full URL. Example: com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number. Example: 1.
remoteboolean- When true, set remoteWorkType=1. Example: false.
sort_bystring- Glassdoor sortBy value (e.g. date_desc). Example: date_desc.
piloterr_google_ai_searchAsk Google AI Mode a question and get its answer text blocks, references and shopping results.Read-onlySearch Google AI Mode
Ask Google AI Mode a question and get its answer text blocks, references and shopping results. Returns JSON with references, text_blocks, shopping_results, search_parameters, reconstructed_markdown. Use this for synthesized answers (3 credits). Use piloterr_google_search for ranked links.
Inputs
querystringrequired- The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted. Example: what is mozilla firefox.
crstring- Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE). Example: countryUS.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
glstring- Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Example: us.
google_domainstring- Google domain to use for the search. Defaults to google.com. Example: google.com.
hlstring- Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Example: en.
locationstring- City or region from which the AI Mode search should originate. Simulates a real user searching from that location. Example: New York, NY.
lrstring- Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de). Example: lang_en.
uulestring- Google-encoded location string for precise geographic targeting. Mutually exclusive with location. Example: w+CAIQICINVW5pdGVkIFN0YXRlcw.
piloterr_google_images_searchSearch Google Images by keyword (100 images per page).Read-onlySearch Google Images
Search Google Images by keyword (100 images per page). Returns JSON with images, search_parameters. Use this to find images and their source pages. Costs 1 credit.
Inputs
querystringrequired- The image search query to execute on Google Images. Example: mountain landscape.
crstring- Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE). Example: countryUS.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
glstring- Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Example: us.
google_domainstring- Google domain to use for the search. Defaults to google.com. Example: google.com.
hlstring- Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Example: en.
lrstring- Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de). Example: lang_en.
pageinteger- Page number for pagination. Images are returned in batches of 100 per page: 1 (First 100 images (default)), 2 (Next 100 images), 3 (Next 100 images, etc). Example: 1.
safestring- Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default. Example: active.one of
activeoff
piloterr_google_maps_searchSearch Google Maps for businesses by name or keyword.Read-onlySearch Google Maps
Search Google Maps for businesses by name or keyword. Returns JSON with status, results. Use this for local business data such as addresses, phone numbers and ratings. Costs 3 credits.
Inputs
querystringrequired- Business name or keyword to search Google Maps for. Example: coffee shops in Austin TX.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_google_searchRun a Google web search with location, language, country and recency filters.Read-onlySearch Google
Run a Google web search with location, language, country and recency filters. Returns JSON with pagination, knowledge_graph, organic_results, related_searches, search_parameters, search_information. Use this for general web search. Use piloterr_google_ai_search for Google AI Mode answers. Costs 1 credit.
Inputs
querystringrequired- The search query to execute on Google. Supports all standard Google search operators. Example: best electric cars 2024.
crstring- Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE). Example: countryUS.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
glstring- Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Example: us.
google_domainstring- Google domain to use for the search. Defaults to google.com. Example: google.com.
hlstring- Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Example: en.
locationstring- City or region from which the search should originate. Simulates a real user's search from the specified location. Example: New York, NY.
lrstring- Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de). Example: lang_en.
numinteger- Maximum number of results to return per page (e.g. 10, 40, 100). Example: 10.
pageinteger- Page number of search results to retrieve: 1 (First page (default)), 2 (Second page, etc). Example: 1.
safestring- Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default. Example: active.one of
activeoff tbsstring- Advanced time-range and filter string for Google Search. Used to restrict results by recency: qdr:h (Last hour), qdr:d (Last day), qdr:w (Last week), qdr:m (Last month), qdr:y (Last year). Example: qdr:w.
uulestring- Google-encoded location string for precise geographic targeting. Example: w+CAIQICINVW5pdGVkIFN0YXRlcw.
piloterr_google_shopping_searchSearch Google Shopping for products, with location, language and country options.Read-onlySearch Google Shopping
Search Google Shopping for products, with location, language and country options. Returns JSON with organic_results, search_parameters. Use this to compare prices across merchants. Costs 1 credit.
Inputs
querystringrequired- Product search query on Google Shopping. Use a product name, brand, or category. Example: playstation 5.
crstring- Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE). Example: countryUS.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
glstring- Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Example: us.
google_domainstring- Google domain to use for the search. Defaults to google.com. Example: google.com.
hlstring- Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Example: en.
locationstring- City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically. Example: New York, United States.
lrstring- Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de). Example: lang_en.
pageinteger- Page number of Shopping results. Each page returns about 20 products. There is no num parameter: 1 (First page (default)), 2 (Second page, etc). Example: 1.
safestring- Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default. Example: active.one of
activeoff uulestring- Google-encoded location string (UULE) for precise geo-targeting. Use location instead if you do not already have an encoded value. Example: w+CAIQICINVW5pdGVkIFN0YXRlcw.
piloterr_huggingface_models_searchSearch Hugging Face models by keyword.Read-onlySearch Hugging Face Models
Search Hugging Face models by keyword. Returns JSON with results, pagination. Pass the pagination.next URL as query to get the next page. Costs 1 credit.
Inputs
querystringrequired- A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page. Example: bert.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_indeed_company_getGet an Indeed employer profile by company slug or /cmp/ URL.Read-onlyGet Indeed Company
Get an Indeed employer profile by company slug or /cmp/ URL. Returns JSON with founded, revenue, website, industry, logo_url, company_url, description, headquarter, staff_range, company_name, and more. Use this for headcount, revenue and industry from Indeed. Costs 2 credits.
Inputs
querystringrequired- Indeed company slug or full /cmp/ URL. Example: Proman-1.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false. Example: false.
piloterr_indeed_job_getGet a full Indeed job posting by URL or 16-character job key.Read-onlyGet Indeed Job
Get a full Indeed job posting by URL or 16-character job key. Returns JSON with url, title, salary, job_key, benefits, job_type, location, company_url, description, remote_work, and more. Use piloterr_indeed_jobs_search to find job keys. Costs 2 credits.
Inputs
querystringrequired- Indeed job URL, sponsored SERP click URL or 16-char jk job key. Example: 585181841cb618e0.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false. Example: false.
piloterr_indeed_jobs_searchSearch Indeed job listings by keyword or Indeed search URL (fr.indeed.com by default).Read-onlySearch Indeed Jobs
Search Indeed job listings by keyword or Indeed search URL (fr.indeed.com by default). Returns JSON with results, pagination. Use piloterr_indeed_job_get for one posting's full description. Costs 2 credits.
Inputs
querystringrequired- Keyword, Indeed /jobs URL or SEO search URL on fr.indeed.com (default domain). Example: developpeur python.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- 1-based page number (10 results per page). Default: 1. Example: 1.
return_page_sourceboolean- When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false. Example: false.
piloterr_instagram_user_getGet a public Instagram profile by username or URL.Read-onlyGet Instagram User
Get a public Instagram profile by username or URL. Returns JSON with id, name, posts, avatar, gender, private, website, username, verified, followers, and more. Use this for creator and brand research. Costs 1 credit.
Inputs
querystringrequired- The Instagram user to look up. Accepts a full profile URL or a username. Example: https://www.instagram.com/example-user/.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_linkedin_company_getGet a LinkedIn company page by slug, URL or company ID, or by reverse lookup from a website domain.Read-onlyGet LinkedIn Company
Get a LinkedIn company page by slug, URL or company ID, or by reverse lookup from a website domain. Returns JSON with posts, founded, tagline, website, industry, logo_url, employees, locations, company_id, company_url, and more. Pass query when you know the LinkedIn page, or domain to look it up from the company website. Costs 1 credit.
Inputs
domainstring- Company website domain for reverse lookup when you do not have the LinkedIn URL. Example: guideflow.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
querystring- LinkedIn company identifier when you already know the page. Example: https://www.linkedin.com/company/ferrari.
piloterr_linkedin_job_getGet one LinkedIn job posting by job ID or URL.Read-onlyGet LinkedIn Job
Get one LinkedIn job posting by job ID or URL. Returns JSON with id, title, address, job_url, industry, location, functions, list_date, recruiter, company_url, and more. Use piloterr_linkedin_jobs_search to find postings. Costs 1 credit.
Inputs
querystringrequired- The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL. Example: https://www.linkedin.com/jobs/view/4390885746.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_linkedin_jobs_searchSearch LinkedIn job postings by keyword with filters for seniority, job type, recency, remote work, location and company.Read-onlySearch LinkedIn Jobs
Search LinkedIn job postings by keyword with filters for seniority, job type, recency, remote work, location and company. Returns JSON with results, pagination. Use piloterr_linkedin_job_get for one posting's full details. Page with page. Costs 1 credit.
Inputs
company_idstring- LinkedIn numeric company ID to filter results to jobs posted by a specific company. Example: 1441.
distanceinteger- Maximum radius in miles from the target location (requires geo_id). Accepted values: 5, 10, 25, 50, 100. Example: 25.
experience_levelstring- Filter by seniority: internship, entry_level, associate, mid_senior or director. Example: internship.one of
internshipentry_levelassociatemid_seniordirector fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
flexibilitystring- Filter by work arrangement. Accepted values: remote (Fully remote positions), flexible (Hybrid or flexible arrangements). Example: remote.one of
remoteflexible geo_idstring- LinkedIn geo ID for the target location. Default is 92000000 (worldwide). Example: 103644278.
job_typestring- Filter by employment type: full_time, part_time, contract, temporary, internship or volunteer. Example: full_time.one of
full_timepart_timecontracttemporaryinternshipvolunteer keywordstring- Job title or keyword to search for. Example: Software Engineer.
pageinteger- Page number. Default is 1. Each page returns up to 10 jobs. Call the next page with pagination.next from the previous response. Example: 2.
whenstring- Filter by posting date recency. Accepted values: day (Posted in the last 24 hours), week (Posted in the last 7 days), month (Posted in the last 30 days). Example: day.one of
dayweekmonth
piloterr_linkedin_post_getGet one LinkedIn post by post ID or URL, with its text, author, media, reactions and comments.Read-onlyGet LinkedIn Post
Get one LinkedIn post by post ID or URL, with its text, author, media, reactions and comments. Returns JSON with id, url, text, author, images, comments, hashtags, image_url, like_count, shared_link, and more. Use this to analyze a specific post. Costs 1 credit.
Inputs
querystringrequired- The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL. Example: https://www.linkedin.com/posts/example-user_activity-7027826235833520128.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_linkedin_profile_getGet a public LinkedIn person profile by username, profile URL or member ID.Read-onlyGet LinkedIn Profile
Get a public LinkedIn person profile by username, profile URL or member ID. Returns JSON with skills, address, summary, articles, headline, username, full_name, languages, photo_url, educations, and more. Use this for candidate or lead research. Costs 1 credit.
Inputs
querystringrequired- The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID. Example: https://www.linkedin.com/in/example-user.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_northdata_company_getGet a North Data company profile (mostly European registers) by name, North Data ID or URL.Read-onlyGet North Data Company
Get a North Data company profile (mostly European registers) by name, North Data ID or URL. Returns JSON with lei, url, name, eu_id, events, extras, status, address, capital, filings, and more. Use this for register, financial and officer data on European companies. Costs 1 credit.
Inputs
querystringrequired- Company name, North Data id, or a profile URL. Example: Maison Boinaud.
countriesstring- ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE. Example: FR.
domainstring- fr (default), com or en, de. Ignored when query is a URL. Example: fr.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_npi_searchSearch the US NPPES NPI registry for healthcare providers and organizations by name, NPI, location or taxonomy.Read-onlySearch NPI Registry
Search the US NPPES NPI registry for healthcare providers and organizations by name, NPI, location or taxonomy. Returns JSON with results, pagination. Use enumeration_type NPI-2 for organizations. Costs 1 credit.
Inputs
citystring- Practice city. Example: Washington.
enumeration_typestring- NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name.one of
NPI-1NPI-2 fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
first_namestring- Example: Anthony. Used as the given name when you do not want query to be split.
last_namestring- Example: Fauci. A single-word query such as Smith is used as the last name.
limitinteger- Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows.
organization_namestring- Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2.
pageinteger- Page number, starting at 1. Example: 2. Defaults to 1.
postal_codestring- Postal code. Example: 20016.
querystring- Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here.
statestring- Two-letter state code. Example: DC. Any other value is rejected.
taxonomystring- Taxonomy description. Example: Internal Medicine.
piloterr_owler_company_getGet Owler company intelligence by slug or URL: revenue, employees, CEO, competitors and funding.Read-onlyGet Owler Company
Get Owler company intelligence by slug or URL: revenue, employees, CEO, competitors and funding. Returns JSON with the Owler company record (cg): name, revenue, employees, CEO, competitors, funding and sectors. Use piloterr_company_get for a domain-based lookup. Costs 1 credit.
Inputs
querystringrequired- Owler company slug, such as airbus, or an Owler company URL. Example: https://owler.com/company/tesla.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_pitchbook_company_getGet a PitchBook company profile by company ID or URL.Read-onlyGet PitchBook Company
Get a PitchBook company profile by company ID or URL. Returns JSON with url, name, status, website, employees, company_id, description, stock_symbol, year_founded, corporate_office, and more. Use this for private-company funding and industry data. Costs 2 credits.
Inputs
querystringrequired- PitchBook company id or company profile URL. Example: 11062-99.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return rendered HTML instead of JSON. Example: false.
piloterr_prnewswire_searchSearch PR Newswire press releases by keyword or news-search URL.Read-onlySearch PR Newswire
Search PR Newswire press releases by keyword or news-search URL. Returns JSON with results, pagination. Use this to find company announcements. Costs 1 credit.
Inputs
querystringrequired- Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected. Example: apple.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1.
piloterr_producthunt_product_getGet a Product Hunt product by URL or slug.Read-onlyGet Product Hunt Product
Get a Product Hunt product by URL or slug. Returns JSON with id, logo, name, slug, tagline, categories, description, posts_count, screenshots, pricing_type, and more. Use this for launch and review data on a product. Costs 1 credit.
Inputs
querystringrequired- A ProductHunt product URL or product slug. Example: https://www.producthunt.com/products/miro.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_similarweb_domain_getGet traffic and engagement metrics for a domain from its public Similarweb page.Read-onlyGet Similarweb Traffic
Get traffic and engagement metrics for a domain from its public Similarweb page. Returns JSON with title, category, site_name, engagments, global_rank, country_rank, top_keywords, category_rank, snapshot_date, traffic_sources, and more. Use this to estimate a website's traffic and audience. Costs 2 credits.
Inputs
querystringrequired- A domain name to retrieve traffic and engagement metrics for. Example: google.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_trustpilot_company_getGet a company's Trustpilot profile by Trustpilot URL or domain.Read-onlyGet Trustpilot Company
Get a company's Trustpilot profile by Trustpilot URL or domain. Returns JSON with id, stars, activity, is_closed, breadcrumb, categories, is_claimed, trust_score, website_url, contact_info, and more. Use this for review reputation research. Costs 1 credit.
Inputs
querystringrequired- A Trustpilot company URL or domain name. Example: https://www.trustpilot.com/review/nordvpn.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_upwork_jobs_searchSearch Upwork freelance job listings by skill slug or freelance-jobs URL.Read-onlySearch Upwork Jobs
Search Upwork freelance job listings by skill slug or freelance-jobs URL. Returns JSON with skill, title, results, pagination. Use this to research freelance demand and budgets for a skill. Costs 2 credits.
Inputs
querystringrequired- Upwork skill slug or full freelance-jobs URL. Example: api-development.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false. Example: false.
piloterr_usage_getGet your Piloterr credit balances, rate limits and API key details.Read-onlyGet Usage
Get your Piloterr credit balances, rate limits and API key details. Free: uses no credits. Returns remaining, total_used, renewal_date, period, subscription (used, total, remaining, percent_used), credits and packs. Use this before large batches to check the remaining balance.
Inputs
This tool takes no inputs.
piloterr_usaspending_searchSearch US federal awards on USAspending by keyword, for contracts, grants, IDVs or loans.Read-onlySearch US Federal Awards
Search US federal awards on USAspending by keyword, for contracts, grants, IDVs or loans. Returns JSON with results, pagination. Use this for government contract research. Costs 1 credit.
Inputs
querystringrequired- Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400.
award_typestring- One group: contract (default when omitted), grant, idv, or loan. Example: grant.one of
contractgrantidvloan fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null.
piloterr_walmart_product_getGet a Walmart product by URL or item ID.Read-onlyGet Walmart Product
Get a Walmart product by URL or item ID. Returns JSON with upc, brand, title, images, offers, rating, reviews, in_stock, location, offer_id, and more. Use piloterr_walmart_search to find item IDs. Costs 2 credits.
Inputs
querystringrequired- Walmart product URL or numeric item id. Example: 138762768.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return {"result": html} instead of the parsed product. Example: false.
piloterr_walmart_searchSearch Walmart products by keyword or search URL.Read-onlySearch Walmart
Search Walmart products by keyword or search URL. Returns JSON with query, results, location, pagination. Use piloterr_walmart_product_get for one product's details. Costs 2 credits.
Inputs
querystringrequired- Keyword or a Walmart search URL. Example: bread.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number, starting at 1. Example: 2.
return_page_sourceboolean- When true, return {"result": html} instead of the parsed cards. Example: false.
piloterr_website_contacts_extractCrawl a website and extract email addresses, phone numbers, contact pages and social media profiles.Read-onlyExtract Website Contacts
Crawl a website and extract email addresses, phone numbers, contact pages and social media profiles. Returns JSON with emails, contact_pages, phone_numbers, reddit_profiles, tiktok_profiles, twitter_profiles, youtube_channels, facebook_profiles, linkedin_profiles, snapchat_profiles, and more. Use this to find contact details on a company site. Use piloterr_email_find to find a specific person's email. Costs 1 credit.
Inputs
querystringrequired- A website URL to crawl for contact information. Must include the http:// or https:// protocol. The crawler will follow internal links ("a" anchors) to find contact details across the site. Example: https://www.hexa.cc.
country_codestring- An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing: FR (France), US (United States), DE (Germany). Example: US.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_website_crawlFetch a public web page over plain HTTP (no JavaScript) and return its HTML.Read-onlyCrawl Web Page
Fetch a public web page over plain HTTP (no JavaScript) and return its HTML. Returns the page HTML (as {"result": html} when return_page_source is true). Try this first for static or server-rendered pages (1 credit). Use piloterr_website_render for JavaScript-heavy pages and piloterr_website_unlock for bot-protected sites.
Inputs
querystringrequired- A public website URL to fetch with the Crawler engine (HTTP only, no JavaScript). Must include http:// or https://. Example: https://example.com.
allow_redirectsboolean- Controls whether the crawler should follow HTTP redirects: true (Follow redirects automatically (default)), false (Stop at the first HTTP response without following any redirect). Example: false.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- Controls whether the response returns the raw, unprocessed HTML source of the page: false (Return processed/parsed content (default)), true (Return the exact HTML source as delivered by the web server). Example: false.
piloterr_website_renderRender a JavaScript-heavy page in a headless browser and return the HTML after scripts run.Read-onlyRender Web Page
Render a JavaScript-heavy page in a headless browser and return the HTML after scripts run. Returns the page HTML (as {"result": html} when return_page_source is true). Use this when piloterr_website_crawl returns an empty page (2 credits). Use piloterr_website_unlock if bot protection blocks the session.
Inputs
querystringrequired- A public website URL to render in a headless browser. Must include http:// or https://. Example: https://example.com.
block_adsboolean- Controls whether the headless browser should block ad requests during rendering: false (Ads are loaded normally (default)), true (Ad network requests are blocked, resulting in cleaner HTML and faster rendering). Example: false.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return {"result": html} instead of the raw HTML string. A proxy error page is still an error and is not returned. Example: false.
timeoutinteger- Maximum seconds to wait for the page to load before returning what has rendered so far. Example: 30.
wait_forstring- A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM. Example: #main-content.
wait_in_secondsinteger- Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations. Example: 2.
piloterr_website_technology_getDetect the technologies behind a website: CMS, frameworks, analytics, CDN, hosting and more.Read-onlyDetect Website Technologies
Detect the technologies behind a website: CMS, frameworks, analytics, CDN, hosting and more. Returns JSON with cms, urls, technologies. Use this for tech-stack research on a company website. Costs 1 credit.
Inputs
querystringrequired- A website URL to analyze for technology stack detection. Must include the http:// or https:// protocol. Example: https://example.com.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
modestring- expert (default) returns confidence scores, versions, CPE identifiers and categories; simple returns the CMS, URL status codes and a flat list of technology names. Example: expert.one of
expertsimple
piloterr_website_unlockFetch a page protected by anti-bot systems (Cloudflare, DataDome, Akamai, PerimeterX) on Piloterr's whitelisted domains.Read-onlyUnlock Web Page
Fetch a page protected by anti-bot systems (Cloudflare, DataDome, Akamai, PerimeterX) on Piloterr's whitelisted domains. Returns the page HTML (as {"result": html} when return_page_source is true). Use this only after piloterr_website_crawl and piloterr_website_render fail (3 credits). The domain must be on Piloterr's whitelist.
Inputs
querystringrequired- A public website URL to unlock with the WebUnlocker engine. Must include http:// or https://. The target domain must be on Piloterr's approved whitelist. Example: https://www.norauto.fr/t/pneu/w-185-h-55-r-14/ete-s/80-l-h-q.html.
allow_redirectsboolean- Controls whether the WebUnlocker engine should follow HTTP redirects: true (Follow redirects automatically (default)), false (Stop at the first HTTP response without following any redirect). Example: false.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- Controls whether the response returns the raw, unprocessed HTML source of the page: false (Return processed/parsed content (default)), true (Return the exact HTML source as delivered by the web server after bot bypass). Example: false.
piloterr_x_post_getGet a public X (Twitter) post by status URL or tweet ID.Read-onlyGet X Post
Get a public X (Twitter) post by status URL or tweet ID. Returns JSON with url, name, text, media, tweet_id, username, verified, created_at, like_count, view_count, and more. Use piloterr_x_profile_get for the author's profile. Costs 2 credits.
Inputs
querystringrequired- X tweet to retrieve. Accepts a full status URL or numeric tweet ID. Example: https://x.com/example-user/status/0000000000000000001.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false. Example: false.
piloterr_x_profile_getGet a public X (Twitter) profile by username, @handle or URL.Read-onlyGet X Profile
Get a public X (Twitter) profile by username, @handle or URL. Returns JSON with url, name, user_id, location, username, verified, created_at, description, tweet_count, followers_count, and more. Use piloterr_x_post_get for a single post. Costs 2 credits.
Inputs
querystringrequired- X profile to look up. Accepts a username, @handle, or profile URL. Example: elonmusk.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
return_page_sourceboolean- When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false. Example: false.
piloterr_yelp_business_getGet a Yelp business profile from its full business URL.Read-onlyGet Yelp Business
Get a Yelp business profile from its full business URL. Returns JSON with url, logo, name, phone, address, website, open_hours, business_id, claim_status. Use piloterr_yelp_reviews_list for reviews. Costs 2 credits.
Inputs
querystringrequired- Full Yelp business URL. Example: https://www.yelp.com/biz/novela-san-francisco-2.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
piloterr_yelp_reviews_listList the reviews of a Yelp business by its business ID, 10 per page.Read-onlyList Yelp Reviews
List the reviews of a Yelp business by its business ID, 10 per page. Returns JSON with url, results, pagination, business_id. Get the business ID from piloterr_yelp_business_get or piloterr_yelp_search. Costs 2 credits.
Inputs
querystringrequired- Yelp business ID / encid. Example: cX5dOMkwZ5rqWbeIJpw_Ig.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
pageinteger- Page number. Each page returns up to 10 reviews. Default: 1. Example: 1.
piloterr_yelp_searchSearch Yelp businesses using a full Yelp search URL with find_desc and find_loc.Read-onlySearch Yelp
Search Yelp businesses using a full Yelp search URL with find_desc and find_loc. Returns JSON with results, pagination. Use piloterr_yelp_business_get for one business and piloterr_yelp_reviews_list for its reviews. Costs 2 credits.
Inputs
querystringrequired- Full Yelp search URL with find_desc and find_loc query parameters. Example: https://www.yelp.com/search?find_desc=Cocktail+Bars&find_loc=San+Francisco%2C+CA.
fieldsstring- Comma-separated response fields to keep, with dot notation for nested fields, for example name,location.city. Shrinks the response; does not reduce credit cost. Example: name,description,website.
No tools match.