API Access

Integrate with our REST API for advanced use cases.

10 min read

Features

Overview

The Flamy API allows you to:

Read your profile data
Manage your links programmatically
Access analytics data
Apply templates to your profile

Authentication

All API requests require an API key. Generate one at Dashboard → API Access.

API Key Format

API keys start with the prefix ezx_ followed by 64 hexadecimal characters:

ezx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Using Your Key

Include your API key in the Authorization header:

bash

curl -X GET "https://api.flamy.lol/v1/profile" \
  -H "Authorization: Bearer ezx_your_api_key_here"

Rate Limits

Rate limits vary by subscription tier:

Tier	Requests/Hour
Free	1,000
Pro	5,000
Creator	10,000
Lifetime	10,000

API Key Limits

The number of active API keys you can create depends on your tier:

Tier	Active Keys
Free	2
Pro	5
Creator	10
Lifetime	10

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1706140800

Endpoints

Base URL: `$ api.flamy.lol/v1`

Get Profile

http

GET /v1/profile

Returns your profile information including bio, avatar, and settings.

List Links

http

GET /v1/links

Returns all your links with their settings.

Parameters	Type	Description
limit	number	Max results (default: 50)
offset	number	Pagination offset
active	boolean	Filter by active status

Create Link

http

POST /v1/links

Creates a new link on your profile.

Update Link

http

PATCH /v1/links/:id

Updates an existing link.

Delete Link

http

DELETE /v1/links/:id

Permanently deletes a link.

Get Analytics

http

GET /v1/analytics

Returns analytics data for your profile.

Parameters	Type	Description
period	string	Time period: 7d, 30d, 90d, 1y
metric	string	Metric type: views, clicks, all

Permissions

When creating an API key, you can configure granular permissions:

Permission	Access
profile:read	Read profile data
profile:write	Update profile settings
links:read	List and view links
links:write	Create and update links
links:delete	Delete links
analytics:read	Access analytics data
templates:read	List available templates
templates:apply	Apply templates to profile

Error Codes

Code	HTTP Status	Description
UNAUTHORIZED	401	Invalid or missing API key
FORBIDDEN	403	Insufficient permissions for this action
NOT_FOUND	404	Requested resource not found
RATE_LIMIT_EXCEEDED	429	Too many requests, please slow down
VALIDATION_ERROR	400	Invalid request parameters
INTERNAL_ERROR	500	Server error, please try again

More Information

For interactive examples and detailed response schemas, check out our API Reference.

Analytics

Premium Features

Back to Documentation