Returns the AUDIT TRAIL behind the caller's own royalty: every ledger row with…
Returns the AUDIT TRAIL behind the caller's own royalty: every ledger row with the spend it was computed from, the share applied at the time, the…
GET /v1/author/basis
| Address | https://api.hanzo.ai/v1/author/basis |
| Method | GET |
| Operation | get_author_basis |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the AUDIT TRAIL behind the caller's own royalty: every ledger row with the spend it was computed from, the share applied at the time, the platform's matching half, whether each row satisfies the formula, and the attribution edges that already existed when the row was written.
It answers ONE OF TWO SHAPES. An org that has never connected gets {"isAuthor": false, "defaultShareBps"} — never a 404, which would answer "is this org an author?" for anyone who asked. An enrolled org gets the basis: isAuthor, id, status, asOf, shareBps, platformShareBps, defaultShareBps, shareSource, settlesTo, method (the formula, the rate card and the sizing), ledger, reconciliation, window, and period when one was requested.
This read NEVER sweeps, and that is the point of it being a separate address from the dashboard: an audit must not move the money it is auditing, so calling it N times leaves the balances and the ledger byte-identical.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
period | query | string | — | Period is the UTC accrual month, YYYY-MM. Empty means every period; any other shape is refused with 400, because the period is echoed back and used as a SQL… |
Response
| Status | Body | Meaning |
|---|---|---|
200 | object | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
* | body | object | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo authors basisimport { Configuration, AuthorApi } from 'hanzoai';
const api = new AuthorApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAuthorBasis();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AuthorApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AuthorApi(client).get_author_basis()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AuthorAPI.GetAuthorBasis(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, author_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = author_api::get_author_basis(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AuthorApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new AuthorApi(client).getAuthorBasis();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/author/basis \
-H "Authorization: Bearer $HANZO_API_KEY"Tool authors, op get_author_basis — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "authors",
"arguments": {
"op": "get_author_basis",
"input": {}
}
}
}'How is this guide?