Skip to content

apiverve/action-seo-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

APIVerve SEO & Web Action

Extract metadata, scrape links, and analyze web pages for SEO

Beta Release - This action is in beta. We'd love your feedback! Open an issue if you encounter any problems.

![GitHub Marketplace](https://img.shields.io/badge/Marketplace-SEO & Web-blue?logo=github) License: MIT

Browse All APIs | Get Free API Key | Documentation


What does this action do?

This action provides access to APIVerve's SEO & Web APIs directly in your GitHub workflows:

  • Extract metadata from web pages
  • Scrape and validate links
  • Get page titles for URLs
  • Quick SEO analysis

Available APIs

API Description
metadataextractor Metadata Extractor is a simple tool for extracting metadata from web pages. It returns the meta title, meta description, and more.
linkscraper Link Scraper is a simple tool for scraping web page links. It returns all the links on a web page.
urltitle URL Title is a simple tool for getting the title of a web page. It returns the title of the web page based on the URL provided.
seoquickcheck seoquickcheck API
websitereadability Website Readability is a simple tool for analyzing the readability of a website. It returns the readability score of the website provided.

Quick Start

- name: SEO & Web
  uses: apiverve/action-seo-web@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: metadataextractor
    params: '{"url": "https://example.com"}'

Setup

1. Get Your API Key

Sign up for a free account at dashboard.apiverve.com/signup and create an API key.

2. Add Secret to Repository

Go to your repository SettingsSecrets and variablesActionsNew repository secret

  • Name: APIVERVE_KEY
  • Value: Your API key from the dashboard

3. Use in Workflow

- name: SEO & Web
  uses: apiverve/action-seo-web@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: metadataextractor
    params: '{"your": "parameters"}'

Inputs

Input Description Required Default
api_key Your APIVerve API key (or set APIVERVE_API_KEY env var) Yes* -
api API to use: metadataextractor, linkscraper, urltitle, seoquickcheck, websitereadability No metadataextractor
params JSON parameters for the API No {}
output_file Path to save binary output (images, PDFs) No -
format Response format: json, yaml, or xml No json
fail_on_error Fail workflow if API returns error No true

*API key is required but can be provided via input OR APIVERVE_API_KEY / APIVERVE_KEY environment variable.

Outputs

Output Description
result Full API response as JSON
data The data field from response as JSON
status API status (ok or error)
file Path to downloaded file (if output_file was used)

Examples

Metadata Extraction

Extract metadata from a webpage

- name: Metadata Extraction
  id: seo-web-0
  uses: apiverve/action-seo-web@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: metadataextractor
    params: '{"url": "https://example.com"}'

- name: Use result
  run: echo "Result: ${{ steps.seo-web-0.outputs.data }}"

Link Scraping

Extract all links from a webpage

- name: Link Scraping
  id: seo-web-1
  uses: apiverve/action-seo-web@v1
  with:
    api_key: ${{ secrets.APIVERVE_KEY }}
    api: linkscraper
    params: '{"url": "https://example.com"}'

- name: Use result
  run: echo "Result: ${{ steps.seo-web-1.outputs.data }}"

Full Workflow Example

name: SEO & Web Workflow

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  seo-web:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run SEO & Web
        id: result
        uses: apiverve/action-seo-web@v1
        with:
          api_key: ${{ secrets.APIVERVE_KEY }}
          api: metadataextractor
          params: '{"url": "https://example.com"}'

      - name: Show result
        run: |
          echo "Status: ${{ steps.result.outputs.status }}"
          echo "Data: ${{ steps.result.outputs.data }}"

Related Actions

Looking for more APIVerve actions?

Browse all APIVerve Actions →


Pricing

  • Free tier - Get started with generous free limits
  • Pro plans - Higher rate limits and priority support for production use

Check out pricing details.


Resources


License

MIT - see LICENSE


Built by APIVerve - 350+ APIs for developers

About

Extract metadata, scrape links, and analyze web pages for SEO

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors