API Reference

Valorcy API Reference

Everything you need to integrate Valorcy into your applications. RESTful endpoints, authentication, SDKs, and comprehensive documentation.

Quick Start

Getting started

1Get your API key

Sign up for a Valorcy account and generate your API key from the dashboard settings. Keys start with bf_sk_ and are unique to your account.

2Authenticate your requests

Include your API key in the Authorization header of every request. Use the Bearer token format shown below.

curl -X GET https://api.Valorcy.com/v1/sites \
  -H "Authorization: Bearer bf_sk_your_api_key_here" \
  -H "Content-Type: application/json"

3Explore the response

All API responses are returned in JSON format with consistent structure including data, meta pagination, and error details.

{
  "data": [
    {
      "id": "site_abc123",
      "name": "My Portfolio",
      "domain": "myportfolio.com",
      "status": "published",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 25
  }
}

Authentication

API authentication

API Key (Bearer Token)

The simplest way to authenticate. Include your API key as a Bearer token in the Authorization header.

Authorization: Bearer bf_sk_your_key

Generate keys from your dashboard
Full access to all permitted endpoints
Rotate keys anytime for security

OAuth 2.0

For applications that need to act on behalf of users. Supports authorization code and client credentials flows.

Authorization: Bearer {access_token}

Industry-standard OAuth 2.0 protocol
Support for authorization code flow
Token refresh and revocation support

Endpoints

API endpoints

Base URL: https://api.Valorcy.com

Sites

Method	Endpoint	Description
GET	/v1/sites	Endpointlist Sites
GET	/v1/sites/:id	Endpointget Site
POST	/v1/sites	Endpointcreate Site
PATCH	/v1/sites/:id	Endpointupdate Site
DELETE	/v1/sites/:id	Endpointdelete Site

Pages

Method	Endpoint	Description
GET	/v1/sites/:id/pages	Endpointlist Pages
GET	/v1/sites/:id/pages/:pageId	Endpointget Page
POST	/v1/sites/:id/pages	Endpointcreate Page
PATCH	/v1/sites/:id/pages/:pageId	Endpointupdate Page
DELETE	/v1/sites/:id/pages/:pageId	Endpointdelete Page

Forms

Method	Endpoint	Description
GET	/v1/sites/:id/forms	Endpointlist Forms
GET	/v1/sites/:id/forms/:formId/submissions	Endpointlist Submissions
POST	/v1/sites/:id/forms/:formId/submissions	Endpointcreate Submission

Analytics

Method	Endpoint	Description
GET	/v1/sites/:id/analytics/visitors	Endpointvisitor Stats
GET	/v1/sites/:id/analytics/pages	Endpointpage Analytics
GET	/v1/sites/:id/analytics/referrers	Endpointreferrer Data

Media

Method	Endpoint	Description
GET	/v1/media	Endpointlist Media
POST	/v1/media/upload	Endpointupload File
DELETE	/v1/media/:fileId	Endpointdelete File

Domains

Method	Endpoint	Description
GET	/v1/domains	Endpointlist Domains
POST	/v1/domains	Endpointconnect Domain
DELETE	/v1/domains/:domainId	Endpointdisconnect Domain

Rate Limits

Rate limits

API rate limits ensure fair usage and platform stability. Limits reset on a rolling window basis.

Plan	Requests	Window	Concurrent
Starter	60	per minute	5
Pro	300	per minute	20
Business	1,000	per minute	50
Enterprise	Custom	—	Custom

Rate limit info is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

SDKs & Libraries

Official SDKs

Accelerate your integration with our official SDKs. Each SDK handles authentication, retries, and type safety out of the box.

⚡

@Valorcy/js

Official JavaScript/TypeScript SDK for Node.js and browsers with full TypeScript support.

JavaScript

🐍

Valorcy-python

Python SDK with async support, type hints, and seamless integration with popular frameworks.

Python

🔷

Valorcy-go

Go SDK with idiomatic error handling, context support, and concurrency patterns.

🐘

Valorcy-php

PHP SDK supporting PSR-7/PSR-18 standards, compatible with Laravel and Symfony.

PHP

💎

Valorcy-ruby

Ruby gem with ActiveSupport integration, Rails-compatible patterns, and clean API.

Ruby

🔗

Valorcy REST

Use directly with any HTTP client. Full OpenAPI 3.0 spec available for code generation.

REST

FAQ

Frequently asked questions

Start building with the Valorcy API today

Get your free API key and start integrating in minutes. Comprehensive docs, SDKs, and support included.

Free tier included 99.9% uptime SLA Official SDKs for 5+ languages