Skip to main content
REST client

Gate

The 1 operation under gate, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.11. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

GET /v1/gate/stats

Gate earnings and 402 conversion for the project

const result = await cs.api.get("/v1/gate/stats");

This path is in the published OpenAPI document but the installed @codespar/sdk does not type it yet, so this one example is not compiled. The call works over HTTP today; cs.api types it after the next release of the package.

Parameters, body and every documented response: GET /v1/gate/stats in the HTTP reference.

On this page

Gate | CodeSpar