githubEdit

Accounts

get

Lists accounts using the provided authorization token.

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

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

application/json
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
chevron-right
200

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

application/json
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
chevron-right
200

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

application/json
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
chevron-right
200

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

application/json
delete
/accounts/{accountName}
200

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