Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Account

An account is a unique identifier on the Tezos blockchain. For more information see the Accounts API documentation on tzKT.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Account(type: null | AccountTypeParameter, alias: null | string, address: null | string, publicKey: null | string, revealed: boolean, balance: number, counter: number, delegationLevel: null | number, delegationTime: null | Date, numContracts: null | number, numActivations: null | number, numDelegations: null | number, numOriginations: null | number, numTransactions: null | number, numReveals: null | number, numMigrations: null | number, firstActivity: null | number, firstActivityTime: null | Date, lastActivity: null | number, lastActivityTime: null | Date, contracts: null | Contract[], operations: null | Operation[], metadata: any): Account
  • internal

    Parameters

    • type: null | AccountTypeParameter
    • alias: null | string
    • address: null | string
    • publicKey: null | string
    • revealed: boolean
    • balance: number
    • counter: number
    • delegationLevel: null | number
    • delegationTime: null | Date
    • numContracts: null | number
    • numActivations: null | number
    • numDelegations: null | number
    • numOriginations: null | number
    • numTransactions: null | number
    • numReveals: null | number
    • numMigrations: null | number
    • firstActivity: null | number
    • firstActivityTime: null | Date
    • lastActivity: null | number
    • lastActivityTime: null | Date
    • contracts: null | Contract[]
    • operations: null | Operation[]
    • metadata: any

    Returns Account

Properties

Readonly address

address: null | string

Readonly alias

alias: null | string

Readonly balance

balance: number

Readonly contracts

contracts: null | Contract[]

Readonly counter

counter: number

Readonly delegationLevel

delegationLevel: null | number

Readonly delegationTime

delegationTime: null | Date

Readonly firstActivity

firstActivity: null | number

Readonly firstActivityTime

firstActivityTime: null | Date

Readonly lastActivity

lastActivity: null | number

Readonly lastActivityTime

lastActivityTime: null | Date

Readonly metadata

metadata: any

Readonly numActivations

numActivations: null | number

Readonly numContracts

numContracts: null | number

Readonly numDelegations

numDelegations: null | number

Readonly numMigrations

numMigrations: null | number

Readonly numOriginations

numOriginations: null | number

Readonly numReveals

numReveals: null | number

Readonly numTransactions

numTransactions: null | number

Readonly operations

operations: null | Operation[]

Readonly publicKey

publicKey: null | string

Readonly revealed

revealed: boolean

Readonly type

type: null | AccountTypeParameter

Methods

toString

  • toString(): null | string

Static byAddress

  • byAddress(address: string, metadata?: boolean, domain?: string): Promise<Account>

  • Gets a single Account from tzKT.

    see

    get account by address.

    example

    Fetch Account by Address

    Usage

     
    let address: string = 'tz1WEHHVMWxQUtkWAgrJBFGXjJ5YqZVgfPVE';
let account: Account = await Account.byAddress(address);

    Parameters

    • address: string
    • metadata: boolean = false
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<Account>

    Returns the Account corresponding to the given address.

Static count

  • count(parameters: null | CountParameters, domain?: string): Promise<number>

Static fromAPI

Static get

Static getMetadata

  • getMetadata(address: string, domain?: string): Promise<any>

  • Gets metadata of an Account from tzKT.

    see

    get account metadata.

    example

    Fetch metadata for an Account

    Usage

     
    let address: string = 'tz1WEHHVMWxQUtkWAgrJBFGXjJ5YqZVgfPVE';
let accountMetadata: any = await Account.getMetadata(address);

    Parameters

    • address: string
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<any>

    Returns the metadata of an Account corresponding to the given address.

Static suggestions

  • suggestions(query: string, domain?: string): Promise<any>

  • Suggests known accounts by part of alias. This endpoint is useful for autocomplete.

    see

    Suggest accounts

    example

    Fetch suggestions for an Account

    Usage

     
    let query: string = 'Quipu';
let accountSuggestions: any[] = await Account.getMetadata(query);

    Parameters

    • query: string
    • domain: string = 'https://api.tzkt.io'

    Returns Promise<any>

    account suggestions.

Generated using TypeDoc