Yoast

Yoast is the maker of the world's most popular WordPress SEO plugin, active on over 13 million sites. Yoast provides developer APIs for integrating SEO metadata, structured data (Schema.org), meta tags, sitemaps, and SEO analysis into headless WordPress sites and third-party platforms. Key products include Yoast SEO Free, Yoast SEO Premium, WooCommerce SEO, Local SEO, Video SEO, and News SEO.

4 APIs 0 Features

SEOWordPressContent OptimizationSchemaMetadata

APIs

Yoast REST API

The Yoast REST API returns all SEO metadata (meta tags, Schema.org JSON-LD, canonical URLs, Open Graph, Twitter Card data, and robots directives) for any URL or post on a WordPr...

Yoast Surfaces API

The Yoast Surfaces API provides a PHP interface for retrieving SEO metadata programmatically within WordPress. It exposes the YoastSEO() surface with methods to get metadata for...

Yoast Metadata API

The Yoast Metadata API provides a PHP interface to add, alter, or remove metadata in the of a WordPress document. Developers can hook into Yoast's meta tag output pipelin...

Yoast Schema API

The Yoast Schema API provides a PHP interface for customizing the Schema.org JSON-LD structured data output generated by Yoast SEO. Developers can add, remove, or modify schema ...

Collections

Yoast REST API

OPEN

Pricing Plans

Yoast Plans Pricing

2 plans

PLANS

Rate Limits

Yoast Rate Limits

1 limits

RATE LIMITS

FinOps

Yoast Finops

FINOPS

Semantic Vocabularies

Yoast Context

5 classes · 26 properties

JSON-LD

API Governance Rules

Yoast API Rules

8 rules · 1 errors 6 warnings

SPECTRAL

JSON Structure

Yoast Seo Metadata Structure

0 properties

JSON STRUCTURE

Example Payloads

Yoast Rest Get Post Seo Example

2 fields

EXAMPLE

Yoast Rest Get Seo Head Example

2 fields

EXAMPLE

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Yoast REST API
  version: 1.0.0
items:
- info:
    name: SEO Head
    type: folder
  items:
  - info:
      name: Get SEO Head for URL
      type: http
    http:
      method: GET
      url: https://{site}/wp-json/yoast/v1/get_head
      params:
      - name: url
        value: ''
        type: query
        description: The full URL of the page to retrieve SEO metadata for
    docs: Returns all SEO metadata for a given URL including meta tags, Schema.org JSON-LD structured data, canonical URL,
      robots directives, Open Graph tags, and Twitter Card data. This is the primary endpoint for headless WordPress implementations.
- info:
    name: Posts
    type: folder
  items:
  - info:
      name: List Posts With SEO Data
      type: http
    http:
      method: GET
      url: https://{site}/wp-json/wp/v2/posts
      params:
      - name: slug
        value: ''
        type: query
        description: Filter by post slug
      - name: page
        value: ''
        type: query
        description: Page number for pagination
      - name: per_page
        value: ''
        type: query
        description: Number of posts per page (max 100)
    docs: Returns WordPress posts with Yoast SEO metadata appended. Each post in the response includes yoast_head (HTML meta
      tags and Schema.org output) and yoast_head_json (structured key/value SEO data).
  - info:
      name: Get Post With SEO Data
      type: http
    http:
      method: GET
      url: https://{site}/wp-json/wp/v2/posts/:id
      params:
      - name: id
        value: ''
        type: path
        description: WordPress post ID
    docs: Returns a single WordPress post with Yoast SEO metadata including yoast_head (HTML output) and yoast_head_json (structured
      SEO data object).
- info:
    name: Pages
    type: folder
  items:
  - info:
      name: List Pages With SEO Data
      type: http
    http:
      method: GET
      url: https://{site}/wp-json/wp/v2/pages
      params:
      - name: slug
        value: ''
        type: query
        description: Filter by page slug
      - name: page
        value: ''
        type: query
        description: Page number for pagination
      - name: per_page
        value: ''
        type: query
        description: Number of pages per page (max 100)
    docs: Returns WordPress pages with Yoast SEO metadata appended. Each page includes yoast_head and yoast_head_json fields.
  - info:
      name: Get Page With SEO Data
      type: http
    http:
      method: GET
      url: https://{site}/wp-json/wp/v2/pages/:id
      params:
      - name: id
        value: ''
        type: path
        description: WordPress page ID
    docs: Returns a single WordPress page with Yoast SEO metadata including yoast_head and yoast_head_json fields.
bundled: true