> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockgence.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to read the reference

> Where each endpoint's reference lives, how to try it and the conventions every response shares.

The API reference is generated from the same code that serves it, so it always matches what it returns. Each endpoint
lists its cost in credits, its parameters, the shape of its response and a playground to try it with your key. Endpoint descriptions are in
Spanish, like the API's messages; paths, parameters and fields are the same in every language.

> [!TIP]
>
> The playground sends the real query to the production API, with your key, and the query **is charged** like any other.
> To explore without spending credits, start with the free endpoints: `GET /v1/account`, `GET /v1/chains`,
> `GET /v1/sources` and `GET /v1/methodology`.

Every path goes against the base URL `https://app.blockgence.com` (with the `/v1` prefix). The raw schema lives at
`https://app.blockgence.com/openapi.json`, in case you want to generate a client.

## Conventions

### Networks

Most endpoints accept `chain` (`ethereum` by default): `ethereum`, `bsc`, `polygon`, `arbitrum`, `base` or `optimism`,
in lowercase, and `tron` on the ones that say so. An unsupported or misspelled network returns `400` with the list of supported ones and is not charged: a
response never carries data from another network. What can be queried on each network (transfers, logs, traces,
labels, security…) is returned by `GET /v1/chains`, for free.

### Addresses and hashes

* An EVM address is `0x` followed by 40 hexadecimal characters; it is normalized to lowercase.
* A transaction hash is `0x` followed by 64 hexadecimal characters.
* Some endpoints also accept Tron or Monero addresses: pass them **as is**, because their format is case-sensitive.

### Amounts

* `value` is the amount with the token's decimals applied.
* If the token's decimals could not be obtained, `value` is `null` and the exact amount goes in `amount_raw`, as a
  string. Decimals are never assumed and a `0` is never shown.
* USD amounts are **as of each transaction's date**, not at today's price. The response says where the price came from.

### Dates

Dates are epoch seconds (UTC), unless the reference says otherwise.

### Coverage

Any response that reads data sources can carry `degraded_sources`: what could not be read and why. Read it before
concluding that something «is not there». See [Errors](https://docs.blockgence.com/en/api/errors.md) and
[Pagination and cutoffs](https://docs.blockgence.com/en/api/pagination-and-cutoffs.md).

### Facts and leads

Responses keep on-chain facts apart from heuristic leads. When a claim is probabilistic, it carries its basis (`basis`),
its confidence (`confidence`) or its reasons (`reasons`). The full methodology, with each rule, its known limits and the
status of its error rate (measured or not yet), is published by `GET /v1/methodology`.

## Try it without code

**1. Pick an endpoint in the reference**

For example, **Account** → `GET /v1/account`, which costs no credits.

**2. Open the playground**

With the button next to the endpoint's path.

**3. Paste your key**

Under the authorization section, in the `X-API-Key` field, as is (`bkg_live_…`, without `Bearer`).

**4. Send the query**

The response shows up in the same panel.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.