API v2 root index — start here (cluster-first cold-start)

GET

/api/v2

const url = 'https://crate.0xhoneyjar.xyz/api/v2';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://crate.0xhoneyjar.xyz/api/v2

Cycle-2b — the v2 root index: the cold-start recipe + every v2 product surface with its auth tier + how to get the key + the runtime error catalogue (code → when → fix). PURE (no DB), edge-cacheable; the human-facing sibling of /api/v2/openapi.json. v2 is the cluster-first stable major: cluster_id is the prime key, sources/releases attach to it.

Responses

200

API v2 root index

application/json

object

object

required

string

Allowed values: api_index

version

required

string

Allowed values: v2

cold_start

required

object

problem

required

string

steps

required

Array<object>

object

step

required

number

call

required

string

gives

required

string

recipes

required

Array<object>

object

task

required

string

steps

required

Array<object>

object

call

required

string

gives

required

string

resources

required

Array<object>

object

name

required

string

url

required

string

auth

required

string

Allowed values: public sync

eli5

required

string

description

required

string

example

required

string

how_to_get_the_key

required

string | null

errors

required

Array<object>

object

code

required

string

http_status

required

integer

when

required

string

fix

required

string

links

required

object

openapi

required

string

docs

required

string

types

required

object

openapi

required

string

generate

required

string

Example

{
  "object": "api_index",
  "version": "v2",
  "resources": [
    {
      "auth": "public"
    }
  ]
}