Quickstart
Create a Fetchproof API key and make your first request.
Four steps. The request below is the published example for GET/v1/youtube/channel.
- 01
Get a key
Sign in at app.fetchproof.com. Open Keys and create a key. The secret is shown once. It starts with
fp_live_. - 02
Call one endpoint
Send the key as
x-api-key. This curl uses the example already published for the operation.curl --request GET 'https://api.fetchproof.com/v1/youtube/channel?handle=NASA' \ --header 'x-api-key: YOUR_API_KEY' - 03
Read the response
A success is JSON:
success,credits_remaining,credits_charged, then the payload.credits_chargedis what this call cost. A failure keeps those credit fields and charges 0. - 04
See the credit cost
The price is the cost table for this operation. The same table decides the charge.
Default: 1 credit
An empty result costs 0 credits.
How charges are determined
Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns.
A call that fails costs 0 credits. A result served from cache costs 0 credits.
`default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins.
A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true).
A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.