Rust API client for openapi
Algorand ledger analytics API.
For more information, please visit https://www.algorand.com/get-in-touch/contact
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 2.0
- Package version: 2.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
Documentation for API Endpoints
All URIs are relative to https://example.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CommonApi | make_health_check | GET /health | Returns 200 if healthy. |
| LookupApi | lookup_account_app_local_states | GET /v2/accounts/{account-id}/apps-local-state | |
| LookupApi | lookup_account_assets | GET /v2/accounts/{account-id}/assets | |
| LookupApi | lookup_account_by_id | GET /v2/accounts/{account-id} | |
| LookupApi | lookup_account_created_applications | GET /v2/accounts/{account-id}/created-applications | |
| LookupApi | lookup_account_created_assets | GET /v2/accounts/{account-id}/created-assets | |
| LookupApi | lookup_account_transactions | GET /v2/accounts/{account-id}/transactions | |
| LookupApi | lookup_application_box_by_id_and_name | GET /v2/applications/{application-id}/box | Get box information for a given application. |
| LookupApi | lookup_application_by_id | GET /v2/applications/{application-id} | |
| LookupApi | lookup_application_logs_by_id | GET /v2/applications/{application-id}/logs | |
| LookupApi | lookup_asset_balances | GET /v2/assets/{asset-id}/balances | |
| LookupApi | lookup_asset_by_id | GET /v2/assets/{asset-id} | |
| LookupApi | lookup_asset_transactions | GET /v2/assets/{asset-id}/transactions | |
| LookupApi | lookup_block | GET /v2/blocks/{round-number} | |
| LookupApi | lookup_transaction | GET /v2/transactions/{txid} | |
| SearchApi | search_for_accounts | GET /v2/accounts | |
| SearchApi | search_for_application_boxes | GET /v2/applications/{application-id}/boxes | Get box names for a given application. |
| SearchApi | search_for_applications | GET /v2/applications | |
| SearchApi | search_for_assets | GET /v2/assets | |
| SearchApi | search_for_transactions | GET /v2/transactions |
Documentation For Models
The model structs live in the algonaut_model::indexer module, not in this
crate (ADR relocate-generated-models): algonaut_indexer keeps only the api /
transport code and depends on algonaut_model for the wire models. The
synthesized <op>200Response/<op>400Response envelopes are renamed to
intentional names there (e.g. AccountResponse, AssetBalancesResponse,
BlockHeadersResponse, ErrorResponse).
To get access to the crate's generated documentation, use:
cargo doc --open