Other endpoints

Extract page metadata

GET

https://api.apicodex.io/url-metadata

/v1/extract

Fetch the target URL and extract title, meta description/keywords, canonical link, charset, html lang, all Open Graph (og:*) tags, all Twitter Card (twitter:*) tags, favicons (link rel containing "icon", resolved to absolute URLs), and Open Graph images.

Returns 400 on bad input and 502 on upstream fetch failure. For non-HTML responses the base request fields are returned with empty metadata collections and an explanatory note.

Extract page metadata › query Parameters

url

string · uri · required

The page URL to inspect. Must use http:// or https://.

Example: https://www.example.com/blog/launch

timeout_ms

integer · min: 1 · max: 20000

Upstream fetch timeout in milliseconds. Capped at 20000.

Example: 10000

Default: 10000

favicon_fallback

boolean

If no icon link is found in the HTML, include the conventional /favicon.ico guess (flagged with "default": true).

Default: true

block_private

boolean

Reject localhost / private-range literal hosts (best-effort SSRF guard). Set to false to allow such hosts.

Default: true

Extract page metadata › Responses

Metadata extracted (or base fields for non-HTML responses)

ExtractResult

url

string · required

The original input URL.

Example: https://www.example.com/blog/launch

final_url

string · required

The URL after following redirects.

Example: https://www.example.com/blog/launch

status

integer · required

HTTP status of the final response.

Example: 200

content_type

string | null · required

object · required

All Open Graph tags as a key/value map.

Example: {"og:title":"We just launched","og:type":"article","og:image":"https://www.example.com/img/launch-hero.png"}

object · required

All Twitter Card tags as a key/value map.

Example: {"twitter:card":"summary_large_image","twitter:image":"https://www.example.com/img/launch-hero.png"}

Favicon[] · required

images

string[] · required

Open Graph image URLs, resolved to absolute.

Example: ["https://www.example.com/img/launch-hero.png"]

title

string | null

description

string | null

keywords

array | null

canonical

string | null

lang

string | null

charset

string | null

note

string

Present only for non-HTML responses.

Example: Response is not HTML; metadata extraction skipped.

GET/v1/extract

curl 'https://api.apicodex.io/url-metadata/v1/extract?url=<string>&apikey=<api-key>'

Example Responses

{
  "url": "http://example.com/blog/launch",
  "final_url": "https://www.example.com/blog/launch",
  "status": 200,
  "content_type": "text/html; charset=utf-8",
  "title": "We just launched — Example Blog",
  "description": "Read about our brand new product launch and what it means for you.",
  "keywords": [
    "launch",
    "product",
    "example",
    "news"
  ],
  "canonical": "https://www.example.com/blog/launch",
  "lang": "en",
  "charset": "utf-8",
  "open_graph": {
    "og:title": "We just launched",
    "og:description": "Read about our brand new product launch.",
    "og:type": "article",
    "og:url": "https://www.example.com/blog/launch",
    "og:site_name": "Example",
    "og:image": "https://www.example.com/img/launch-hero.png",
    "og:image:width": "1200",
    "og:image:height": "630"
  },
  "twitter": {
    "twitter:card": "summary_large_image",
    "twitter:site": "@example",
    "twitter:title": "We just launched",
    "twitter:description": "Read about our brand new product launch.",
    "twitter:image": "https://www.example.com/img/launch-hero.png"
  },
  "favicons": [
    {
      "rel": "icon",
      "href": "https://www.example.com/favicon-32.png",
      "sizes": "32x32",
      "type": "image/png"
    },
    {
      "rel": "apple-touch-icon",
      "href": "https://www.example.com/apple-touch-icon.png",
      "sizes": "180x180",
      "type": null
    }
  ],
  "images": [
    "https://www.example.com/img/launch-hero.png"
  ]
}

json

application/json

Extract page metadata

GET

https://api.apicodex.io/url-metadata

/v1/extract

Returns 400 on bad input and 502 on upstream fetch failure. For non-HTML responses the base request fields are returned with empty metadata collections and an explanatory note.

Extract page metadata › query Parameters

url

string · uri · required

The page URL to inspect. Must use http:// or https://.

Example: https://www.example.com/blog/launch

timeout_ms

integer · min: 1 · max: 20000

Upstream fetch timeout in milliseconds. Capped at 20000.

Example: 10000

Default: 10000

favicon_fallback

boolean

If no icon link is found in the HTML, include the conventional /favicon.ico guess (flagged with "default": true).

Default: true

block_private

boolean

Reject localhost / private-range literal hosts (best-effort SSRF guard). Set to false to allow such hosts.

Default: true

Extract page metadata › Responses

Metadata extracted (or base fields for non-HTML responses)

ExtractResult

url

string · required

The original input URL.

Example: https://www.example.com/blog/launch

final_url

string · required

The URL after following redirects.

Example: https://www.example.com/blog/launch

status

integer · required

HTTP status of the final response.

Example: 200

content_type

string | null · required

object · required

All Open Graph tags as a key/value map.

Example: {"og:title":"We just launched","og:type":"article","og:image":"https://www.example.com/img/launch-hero.png"}

object · required

All Twitter Card tags as a key/value map.

Example: {"twitter:card":"summary_large_image","twitter:image":"https://www.example.com/img/launch-hero.png"}

Favicon[] · required

images

string[] · required

Open Graph image URLs, resolved to absolute.

Example: ["https://www.example.com/img/launch-hero.png"]

title

string | null

description

string | null

keywords

array | null

canonical

string | null

lang

string | null

charset

string | null

note

string

Present only for non-HTML responses.

Example: Response is not HTML; metadata extraction skipped.