Try an endpoint before you write code

Choose a platform and an endpoint, edit the parameters and copy the request. The response panel shows the recorded response for the endpoint, mapped through the same rules the API applies.

Browse the referenceURL to endpointGet a free key

Request

Fetch a Hacker News user profile.

stable1 credit

Parameters

HN username (case-sensitive), e.g. pg

Request preview

curl "https://api.onekey.dev/v1/hackernews/user?username=pg" \n  -H "x-api-key: YOUR_API_KEY"

Run live calls this endpoint through the site’s shared try-out key, which is rate limited. The response panel then shows the live result instead of the recorded one.

Recorded response

The endpoint’s recorded fixture, mapped through the same rules the API applies. Values are examples, not live data.

{
  "success": true,
  "data": {
    "author": {
      "id": "pg",
      "username": "pg"
    },
    "ext": {
      "karma": 157316
    },
    "content": {
      "text": "Bug fixer."
    }
  },
  "metadata": {
    "platform": "hackernews",
    "endpoint": "user",
    "cached": false,
    "credits_charged": 1
  },
  "error": null
}

What this is, and is not

The request preview is the exact call: GET https://api.onekey.dev/v1/hackernews/user with your key in the x-api-key header. The recorded response is the endpoint’s test fixture mapped through its rules, so it shows the real field names and shapes; the values are examples, not live data.

Run live works only for the small set of endpoints on the site’s try-out list (37 endpoints), through a shared key that is rate limited per visitor. Everything else shows the recorded response and never calls the API. Prices, statuses and parameters come from the registry. Something marked beta is not yet verified against the live source. See Credits & pricing for what a call costs.

The host in the curl is the placeholder API host until the public domain is announced.

Keep reading