apyhub
Back
▣ DATA EXTRACTION · DATA VALIDATION

Web Search & Analysis API

What it does

The Web Search & Analysis API helps you search the web, extract webpage content, retrieve website ranking information, and identify article metadata.

Use Search Web to find relevant webpages by providing a search query. Use Extract Content from a Web Page to retrieve the title, images, HTML, and main text from a specific webpage by passing its URL.

For article information, use Extract Publish Date to retrieve the publication date of an article and Extract Authors to identify the author names and profile links. For both endpoints, provide the URL of the specific article or webpage you want to analyze.

Use Retrieve Page Rank to get ranking information for a website by providing its domain name. The response includes the position, page rank score, and percentile.

These endpoints are useful for web research, content analysis, SEO insights, and article metadata extraction.

▣ ENDPOINT 01 / 05
GET
Retrieve Page Rank API
https://api.eu.apyhub.com/skycraft/web-search-analysis/retrieve-page-rank

QUICKSTART

GUIDE

Quickstart

Look up the page rank for a domain by passing it as a query parameter.

curl -X GET "https://api.eu.apyhub.com/skycraft/web-search-analysis/retrieve-page-rank?domain=amazon.com" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with these optional top-level fields: position as an integer, page_rank as a number, and percentile as a number.

{
  "page_rank": 9.13,
  "position": 30,
  "percentile": 0.9999971
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Retrieves the page rank information for a domain passed in the query string. The response returns a JSON object with position, page_rank, and percentile fields.

Query Parameter(s)

AttributeTypeDescription
domainStringDomain name to retrieve page rank for. Maximum length: 100 characters.

Response

Returns a JSON object with three numeric fields: position as an integer, page_rank as a number, and percentile as a number.

ParameterTypeDescription
positionIntegerPage rank position.
page_rankNumberPage rank score.
percentileNumberPage rank percentile.
▣ ENDPOINT 02 / 05
GET
Extract Publish Date API
https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-publish-date

QUICKSTART

GUIDE

Quickstart

Extract the publish date from a webpage by passing its url as a query parameter.

curl -X GET "https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-publish-date?url=https%3A%2F%2Fwww.nytimes.com%2F2024%2F03%2F27%2Fworld%2Faustralia%2Feconomy-cost-of-living.html" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a publish_date string field, which may be null if the date can't be determined.

{
  "publish_date": "2024-03-27"
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Extracts the publish date from the web page at the provided URL and returns it in the response.

Query Parameter(s)

AttributeTypeDescription
urlStringThe page URL to inspect. Must match the schema pattern and is limited to 1000 characters.

Response

Returns a JSON object with a publish_date string field, or null when a publish date could not be extracted.

ParameterTypeDescription
publish_dateStringThe publish date as YYYY-MM-DD, or null if none was found.
▣ ENDPOINT 03 / 05
GET
Search Web API
https://api.eu.apyhub.com/skycraft/web-search-analysis/search-web

QUICKSTART

GUIDE

Quickstart

Search the web for a required query term, optionally limiting the number of results.

curl -X GET "https://api.eu.apyhub.com/skycraft/web-search-analysis/search-web?query=penguins" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a results array. Each item in results is an object that may include url, title, and summary strings.

{
  "results": [
    {
      "url": "//duckduckgo.com/l/?uddg=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FPenguin&rut=508a4405e945e3f0eb2e51362f3138ef96e0365e0e80c5c2a92724dc6cf1282a",
      "title": "Penguin - Wikipedia",
      "summary": "Penguins are a group of flightless semi-aquatic sea birds which live almost exclusively in the Southern Hemisphere. Only one species, the Galapagos penguin, lives at, and slightly north of, the equator. Highly adapted for life in the ocean water, penguins have countershaded dark and white plumage and flippers for swimming. Most penguins feed on krill, fish, squid and other forms of sea life ..."
    }
  ]
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Searches the web for the supplied query and returns a JSON object containing a results array of search result objects.

Query Parameter(s)

AttributeTypeDescription
queryStringSearch terms to look up. Max length: 300 characters.
numberIntegerNumber of results to return. Integer between 1 and 50.

Response

Returns a JSON object with a results array field. Each item in results is an object with url, title, and summary string fields; each of these fields is nullable.

ParameterTypeDescription
resultsObject ArrayArray of search result objects. Each item contains url, title, and summary.
results[].urlStringResult URL. Nullable.
results[].titleStringResult title. Nullable.
results[].summaryStringResult summary. Nullable.
▣ ENDPOINT 04 / 05
GET
Extract Content from a Web Page API
https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-content

QUICKSTART

GUIDE

Quickstart

Fetch extracted content from a webpage by passing the page URL as a query parameter.

curl -X GET "https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-content?url=https%3A%2F%2Fwww.nytimes.com%2F2024%2F03%2F27%2Fworld%2Faustralia%2Feconomy-cost-of-living.html" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with title, images, main_html, and main_text fields. title, main_html, and main_text are nullable strings, and images is an array of nullable strings.

{
  "title": "Example article title",
  "images": ["https://example.com/image.jpg"],
  "main_html": "<article>...</article>",
  "main_text": "Example extracted article text"
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Extracts the main content from a web page URL and returns a JSON object containing the page title, image URLs, extracted main HTML, and extracted main text.

Query Parameter(s)

AttributeTypeDescription
urlStringThe web page URL to extract content from. Maximum length: 1000 characters.

Response

Returns a JSON object with four nullable fields: title as a string, images as an array of strings, main_html as a string, and main_text as a string. The schema does not declare a nested wrapper, so these fields are returned at the top level.

ParameterTypeDescription
titleStringThe extracted page title, or null if unavailable.
imagesString ArrayThe extracted image URLs, with each item nullable in the schema.
main_htmlStringThe extracted main HTML content, or null if unavailable.
main_textStringThe extracted main text content, or null if unavailable.
▣ ENDPOINT 05 / 05
GET
Extract Authors API
https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-authors

QUICKSTART

GUIDE

Quickstart

Fetch authors for a given article URL by passing the URL as a query parameter.

curl -X GET "https://api.eu.apyhub.com/skycraft/web-search-analysis/extract-authors?url=https%3A%2F%2Fwww.nytimes.com%2F2024%2F03%2F27%2Fworld%2Faustralia%2Feconomy-cost-of-living.html" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with an authors array field. Each item in authors is an object with optional link and name string fields, both of which may be null.

{
  "authors": [
    {
      "link": "https://www.nytimes.com/by/jane-doe",
      "name": "Jane Doe"
    }
  ]
}
TRY ITLIVE · 20 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Extracts author information from the page at the provided URL and returns it in a JSON object.

Query Parameter(s)

AttributeTypeDescription
urlStringThe page URL to analyze. Must match the schema pattern and be at most 1000 characters long.

Response

Returns a JSON object with an authors array field. Each array item is an object that may contain link and name string fields, both nullable.

ParameterTypeDescription
authorsObject ArrayArray of author objects.
authors[].linkStringAuthor link; nullable.
authors[].nameStringAuthor name; nullable.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.