Outrank Blog API Client

Client library for reading published Outrank articles from the Next.js Blog integration.

Installation

npm install outrank-next-js-blog

Usage

import { BlogClient } from 'outrank-next-js-blog';

const client = new BlogClient(process.env.OUTRANK_BLOG_API_KEY!);

const { articles, total } = await client.getArticles(1, 12);
const tagArticles = await client.getTagArticles('seo', 1, 12);
const article = await client.getArticle('your-article-slug');

Keep OUTRANK_BLOG_API_KEY server-side only. Do not expose it with a NEXT_PUBLIC_ prefix.

API

new BlogClient(apiKey, options?)

Creates an Outrank Blog API client.

const client = new BlogClient('your_api_key', {
  baseUrl: 'https://outrank.so',
  timeoutMs: 30000,
});

getArticles(page?, limit?)

Returns a paginated list of published article summaries. Pages are one-based.

const response = await client.getArticles(1, 12);

getTagArticles(tag, page?, limit?)

Returns published article summaries filtered by tag.

const response = await client.getTagArticles('seo', 1, 12);

getArticle(slug)

Returns one published article by slug, or null when it is not found.

const article = await client.getArticle('how-to-rank');

getAllArticles(limit?)

Returns all published article summaries by paging through the API.

const articles = await client.getAllArticles();

Article Summary Shape

List methods return summaries without article body fields.

type ArticleSummary = {
  id: string;
  title: string;
  slug: string;
  meta_description: string;
  image_url: string;
  tags: string[];
  created_at: string;
  updated_at: string;
  reading_time_minutes: number;
};

Article Shape

getArticle(slug) returns the full article body fields.

type Article = {
  id: string;
  title: string;
  slug: string;
  meta_description: string;
  html: string;
  content_markdown: string;
  image_url: string;
  tags: string[];
  created_at: string;
  updated_at: string;
  reading_time_minutes: number;
};