For the complete documentation index, see llms.txt. This page is also available as Markdown.

Accounts

get

Lists accounts using the provided authorization token.

Authorizations
AuthorizationstringRequired
Header parameters
AuthorizationstringRequired
  • The authorization token from the request header.
Responses
200

A promise that resolves to an AccountAPIResponse object containing the list of accounts.

application/json

Interface representing the response from the Account API. Extends the BaseAPIResponse to include additional data specific to account responses.

successbooleanRequired

The success status of the operation.

messagestringRequired

The message associated with the operation.

addressstringOptional

The address associated with the operation.

get
/accounts
200

A promise that resolves to an AccountAPIResponse object containing the list of accounts.

post

Creates a new account using the provided authorization token and account input data.

Authorizations
AuthorizationstringRequired
Header parameters
AuthorizationstringRequired
  • The authorization token from the request header.
Body
  • The input data required to create a new account.
private_keystringOptional

An optional private key for the account.

Responses
200

A promise that resolves to an AccountAPIResponse object containing the success status, message, and data.

application/json

Interface representing the response from the Account API. Extends the BaseAPIResponse to include additional data specific to account responses.

successbooleanRequired

The success status of the operation.

messagestringRequired

The message associated with the operation.

addressstringOptional

The address associated with the operation.

post
/accounts
200

A promise that resolves to an AccountAPIResponse object containing the success status, message, and data.

get

Retrieves the account details for a given account name.

Authorizations
AuthorizationstringRequired
Path parameters
accountNamestringRequired
  • The name of the account to retrieve.
Header parameters
AuthorizationstringRequired
  • The authorization token from the request header.
Responses
200

A promise that resolves to an AccountAPIResponse object containing the account details.

application/json

Interface representing the response from the Account API. Extends the BaseAPIResponse to include additional data specific to account responses.

successbooleanRequired

The success status of the operation.

messagestringRequired

The message associated with the operation.

addressstringOptional

The address associated with the operation.

get
/accounts/{accountName}
200

A promise that resolves to an AccountAPIResponse object containing the account details.

delete

Deletes an account based on the provided account name.

Authorizations
AuthorizationstringRequired
Path parameters
accountNamestringRequired
  • The name of the account to be deleted.
Header parameters
AuthorizationstringRequired
  • The authorization token from the request header.
Responses
200

A promise that resolves to an AccountAPIResponse object indicating the success or failure of the operation.

application/json

Interface representing the response from the Account API. Extends the BaseAPIResponse to include additional data specific to account responses.

successbooleanRequired

The success status of the operation.

messagestringRequired

The message associated with the operation.

addressstringOptional

The address associated with the operation.

delete
/accounts/{accountName}
200

A promise that resolves to an AccountAPIResponse object indicating the success or failure of the operation.