LIlinkup
Fetch

/fetch

Changed on

The /fetch endpoint allows you to fetch a single webpage from a given URL.

post/v1/fetch

Request

  • Base URL
    https://api.linkup.so
  • URL
    https://api.linkup.so/v1/fetch
  • Auth
    HTTP bearer

Request body

mode'standard' | 'pro'

Defines the fetch strategy. Pro fetch delivers significantly higher success rates on hard-to-retrieve pages.

instructionsstring

Optional instructions that guide how data is extracted. Requires schema.

schemaunknown
urlstring uri required

The URL of the webpage you want to fetch.

Example request

{
  "mode": "standard",
  "instructions": "Use public list prices only and express monetary values in USD.",
  "url": "https://docs.linkup.so"
}

Response

Successful response

contentTypestring

The type of rawContent. Present only when rawContent is returned.

dataobject

Structured data extracted from the webpage. Present only when schema is provided; fields with no grounded value are omitted.

faviconstring uri required

The URL of the website favicon.

markdownstring required

The clean markdown version of the webpage.

rawContentstring

The raw page content.

rawHtmlstring

The raw HTML version of the webpage.

Example response

{
  "contentType": "html",
  "data": {
    "name": "Example product",
    "price": 49
  },
  "favicon": "https://favicons.linkup.so?domain=docs.linkup.so",
  "images": [
    {
      "alt": "Image 1",
      "url": "https://example.com/image.jpg"
    },
    {
      "alt": "Image 2",
      "url": "https://example.com/image2.jpg"
    }
  ],
  "markdown": "Get started for free, no credit card required...",
  "rawContent": "<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>",
  "rawHtml": "<!DOCTYPE html><html lang=\"en\"><head>...</head><body>...</body></html>"
}

Changes

  • b9bcfb4b9efdRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property rawHtml deprecated

    • info

      added the required property to the response with the status