Skip to main content
Developer Documentation

Articles API

RESTful API for accessing published articles, categories, and content data

Quick Start
1

Get API Key

Contact support to receive your API key

2

Make Request

Include X-API-Key header in requests

3

Get Data

Receive JSON responses instantly

Secure

API key authentication

Rate Limited

60-100 req/min

JSON Format

Standard responses

Fast

Sub-second responses

API Endpoints

GET
/articlesAPI
List Articles

Fetch published articles with optional filtering and pagination

Query Parameters

category
string

Filter by category (e.g., web_development, seo)

startDate
string

Filter articles published after this date (ISO format)

endDate
string

Filter articles published before this date (ISO format)

limit
number

Number of articles to return (default: 50, max: 100)

offset
number

Pagination offset (default: 0)

sortBy
string

Sort field: published_date, views, created_date (default: published_date)

sortOrder
string

Sort order: asc or desc (default: desc)

Example Request

curl -X GET "https://your-domain.com/articlesAPI?limit=10&category=web_development" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "success": true,
  "data": [
    {
      "id": "abc123",
      "title": "Getting Started with React",
      "subtitle": "A comprehensive guide for beginners",
      "excerpt": "Learn the basics of React...",
      "category": "web_development",
      "categories": ["web_development", "tutorials"],
      "tags": ["react", "javascript"],
      "author": "John Doe",
      "readTime": 5,
      "views": 1234,
      "featuredImage": "https://...",
      "publishedDate": "2024-01-15",
      "slug": "getting-started-with-react"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 45,
    "hasMore": true,
    "nextOffset": 10
  },
  "timestamp": "2024-01-20T10:30:00Z"
}
GET
/articleByIdAPI
Get Article by ID

Fetch a specific article by its ID

Query Parameters

id
string
Required

Article ID

Example Request

curl -X GET "https://your-domain.com/articleByIdAPI?id=abc123" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "title": "Getting Started with React",
    "subtitle": "A comprehensive guide",
    "content": "<p>Full article content...</p>",
    "category": "web_development",
    "categories": ["web_development", "tutorials"],
    "tags": ["react", "javascript"],
    "author": "John Doe",
    "readTime": 5,
    "views": 1234,
    "featuredImage": "https://...",
    "publishedDate": "2024-01-15",
    "slug": "getting-started-with-react",
    "metaTitle": "Getting Started with React - Complete Guide",
    "metaDescription": "Learn React from scratch...",
    "metaKeywords": ["react", "tutorial", "beginner"],
    "ogImage": "https://...",
    "ogTitle": "Getting Started with React",
    "ogDescription": "A comprehensive guide..."
  },
  "timestamp": "2024-01-20T10:30:00Z"
}
GET
/articlesBySlugAPI
Get Article by Slug

Fetch a specific article by its URL slug

Query Parameters

slug
string
Required

Article URL slug

Example Request

curl -X GET "https://your-domain.com/articlesBySlugAPI?slug=getting-started-with-react" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "title": "Getting Started with React",
    "slug": "getting-started-with-react",
    ...
  },
  "timestamp": "2024-01-20T10:30:00Z"
}
GET
/categoriesAPI
List Categories

Get all article categories with article counts

Example Request

curl -X GET "https://your-domain.com/categoriesAPI" \
  -H "X-API-Key: your_api_key_here"

Example Response

{
  "success": true,
  "data": [
    {
      "name": "web_development",
      "displayName": "Web Development",
      "description": "Web development tutorials and best practices",
      "articleCount": 12
    },
    {
      "name": "seo",
      "displayName": "SEO",
      "description": "Search engine optimization guides",
      "articleCount": 8
    }
  ],
  "total": 2,
  "timestamp": "2024-01-20T10:30:00Z"
}

Code Examples

// JavaScript / Node.js Example
const API_KEY = 'your_api_key_here';
const BASE_URL = 'https://your-domain.com';

async function fetchArticles(options = {}) {
  const params = new URLSearchParams(options);
  const response = await fetch(`${BASE_URL}/articlesAPI?${params}`, {
    headers: {
      'X-API-Key': API_KEY
    }
  });
  
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  
  const data = await response.json();
  return data;
}

// Usage
fetchArticles({ 
  category: 'web_development', 
  limit: 10 
})
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
Authentication

All API requests require authentication using an API key passed in the request header:

X-API-Key: your_api_key_here
API keys are unique per application
Keep your API key secure
Contact support to get your key
Rate Limiting

API requests are rate limited to ensure fair usage:

60/min
List Endpoints
100/min
Single Item

Rate limit information is included in response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 32

Need Help?

Contact our support team to get your API key or assistance with integration