</> Developers

Build withFileYield.

REST API for listing data assets, posting requests, and managing deals. Simple key auth. Rate limits. Full CRUD.

RESTJSONCRUDAPI KEYSRATE LIMITSWEBHOOKSOAUTHPAGINATION

Quick Start

Three steps.steps.

01

Get your API key

Sign up, go to Dashboard → API Keys. Keys start with fy_ and are 40 characters.

02

Create a listing

POST your data asset with name, category, formats, volume, and pricing.

bash
curl -X POST https://fileyield.vercel.app/api/v1/listings \
  -H "Authorization: Bearer fy_xxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "US Consumer Purchase History — 2024",
    "category": "Retail",
    "formats": ["CSV", "Parquet"],
    "volume": "24M records",
    "time_range": "2020-2024",
    "visibility": "public",
    "asking_price": "$450K",
    "price_type": "listed"
  }'
03

Browse requests

See what buyers are looking for. Match your data to demand.

bash
curl https://fileyield.vercel.app/api/v1/requests?public=true \
  -H "Authorization: Bearer fy_xxxxxxxxxxxxxxxxxxxxx"

Endpoints

API endpoints.endpoints.

POST
/api/v1/listingsCreate a listing
GET
/api/v1/listingsList your listings
GET
/api/v1/listings?public=trueBrowse public listings
PATCH
/api/v1/listings/:idUpdate a listing
DELETE
/api/v1/listings/:idRemove a listing
POST
/api/v1/requestsPost a data request
GET
/api/v1/requestsList your requests
GET
/api/v1/requests?public=trueBrowse all requests
POST
/api/v1/keysGenerate API key
GET
/api/v1/keysList your keys

Authentication

Keys & limits.limits.

Key Format

fy_xxxxxxxxxxxxxxxxxxxx...

40 characters, SHA-256 hashed at rest

Header

Authorization: Bearer fy_...

Required on all API v1 requests

Rate Limits by Trust Tier

Standard

5/min

10/day

Verified

60/min

1,000/day

Enterprise

300/min

Unlimited

Example

Create a listing.listing.

Request

bash
curl -X POST https://fileyield.vercel.app/api/v1/listings \
  -H "Authorization: Bearer fy_xxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "US Consumer Purchase History — 2024",
    "category": "Retail",
    "formats": ["CSV", "Parquet"],
    "volume": "24M records",
    "time_range": "2020-2024",
    "visibility": "public",
    "asking_price": "$450K",
    "price_type": "listed"
  }'

Response 201

json
{
  "success": true,
  "data": {
    "id": "a1b2c3d4-...",
    "name": "US Consumer Purchase History — 2024",
    "category": "Retail",
    "status": "listed",
    "visibility": "public",
    "created_at": "2026-04-04T18:30:00Z"
  }
}

Your data,
your API.API.