Skip to content

Latest commit

History

History
87 lines (57 loc) 路 3.79 KB

AccountsApi.md

File metadata and controls

87 lines (57 loc) 路 3.79 KB

{{classname}}

All URIs are relative to https://rest-canary.onflow.org/v1/

Method HTTP request Description
AccountsAddressGet Get /accounts/{address} Get an Account By Address
AccountsAddressKeysIndexGet Get /accounts/{address}/keys/{index} Get an individual Account Key By Address and Index

AccountsAddressGet

Account AccountsAddressGet(ctx, address, optional) Get an Account By Address

Get an account data by provided address in latest "sealed" block or by provided block height.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
address string The address of the account.
optional *AccountsApiAccountsAddressGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AccountsApiAccountsAddressGetOpts struct

Name Type Description Notes

blockHeight | optional.Interface of BlockHeight| The block height to query for the account details at the "sealed" is used by default. | expand | optional.Interface of []string| A comma-separated list indicating which properties of the content to expand. | select_ | optional.Interface of []string| A comma-separated list indicating which properties of the content to return. |

Return type

Account

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AccountsAddressKeysIndexGet

AccountPublicKey AccountsAddressKeysIndexGet(ctx, address, index, optional) Get an individual Account Key By Address and Index

Get an account data by provided address in latest "sealed" block or by provided block height.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
address string The address of the account.
index string The index of the account key.
optional *AccountsApiAccountsAddressKeysIndexGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AccountsApiAccountsAddressKeysIndexGetOpts struct

Name Type Description Notes

blockHeight | optional.Interface of BlockHeight| The block height to query for the account details at the "sealed" is used by default. | expand | optional.Interface of []string| A comma-separated list indicating which properties of the content to expand. | select_ | optional.Interface of []string| A comma-separated list indicating which properties of the content to return. |

Return type

AccountPublicKey

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]