REST API Overview

The Simplist REST API provides direct HTTP access to all Simplist features. You can use it from any programming language or HTTP client.

Base URL

All API endpoints are relative to:

https://api.simplist.blog

Authentication

All requests require authentication via an API key in the X-API-Key header:

curl -X GET "https://api.simplist.blog/v1/articles" 
     -H "X-API-Key: YOUR_API_KEY"

Response Format

All successful responses return a JSON object with this structure:

{
  "data": { /* response data */ },
  "meta": { /* optional pagination metadata */ }
}

Pagination Metadata

For list endpoints, the meta object contains pagination information:

{
  "data": [/* articles */],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 42,
    "totalPages": 5
  }
}

Error Handling

Errors return a JSON object with this structure:

{
  "error": "Error type",
  "message": "Detailed error message",
  "statusCode": 400,
  "details": { /* additional error details */ }
}

Rate Limits

The API has the following rate limits:

• 100 requests per minute for authenticated requests
• 20 requests per minute for unauthenticated requests

Available Endpoints

Articles

• GET/v1/articles (list with pagination)
• GET/v1/articles/:slug (get a specific article)

Project

• GET/v1/project (project info and stats)

Analytics

• POST/v1/analytics/track (track a new page view)
• PUT/v1/analytics/track/:id (update a page view)
• GET/v1/analytics/stats (analytics statistics)

SEO

• GET/v1/seo/article/:slug (article with SEO metadata)
• GET/v1/seo/sitemap (sitemap)
• GET/v1/seo/rss (RSS feed)
• GET/v1/seo/structured-data (JSON-LD structured data)

Need the SDK?

If you're using TypeScript/JavaScript, we recommend using the Simplist SDK for a better developer experience.