Preparing search index...
The search index is not available
TzKT SDK
TzKT SDK
@tzkt/sdk-api
contractsGetInterface
Function contractsGetInterface
contracts
Get
Interface
(
address
:
string
, opts
?:
RequestOpts
)
:
Promise
<
ContractInterface
>
Get JSON Schema [2020-12] interface for the contract
Parameters
address:
string
Optional
opts:
RequestOpts
Returns
Promise
<
ContractInterface
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Modules
TzKT SDK
Changelog
@tzkt/ext-
taquito
@tzkt/sdk-
api
@tzkt/sdk-
events
Account
Account
Parameter
Account
Type
Parameter
Activation
Operation
Address
Null
Parameter
Address
Parameter
Alias
Annotation
Type
Baker
Rewards
Baking
Operation
Baking
Right
Baking
Right
Status
Parameter
Baking
Right
Type
Parameter
Ballot
Operation
Big
Map
Big
Map
Action
Parameter
Big
Map
Diff
Big
Map
Interface
Big
Map
Key
Big
Map
Key
Historical
Big
Map
Key
Short
Big
Map
Key
Update
Big
Map
Tags
Parameter
Big
Map
Update
Block
Bool
Parameter
Commitment
Constant
Contract
Contract
Event
Contract
Interface
Contract
Kind
Parameter
Contract
Tags
Parameter
Contract
View
Creator
Info
Cycle
Date
Time
Parameter
Delegate
Delegate
Info
Delegation
Operation
Delegator
Delegator
Rewards
Domain
Double
Baking
Operation
Double
Endorsing
Operation
Double
Preendorsing
Operation
Drain
Delegate
Operation
Endorsement
Operation
Endorsing
Reward
Operation
Entrypoint
Entrypoint
Interface
Event
Interface
Expression
Parameter
Historical
Balance
IAnnotation
IMicheline
Increase
Paid
Storage
Operation
Int32
Null
Parameter
Int32
Parameter
Int64
Null
Parameter
Int64
Parameter
Json
Parameter
Manager
Info
Micheline
Format
Micheline
Prim
Micheline
Type
Migration
Kind
Parameter
Migration
Operation
Nat
Parameter
Nonce
Revelation
Operation
Offset
Parameter
Operation
Operation
Error
Operation
Status
Parameter
Originated
Contract
Origination
Operation
Period
Info
Preendorsement
Operation
Prim
Type
Proposal
Proposal
Alias
Proposal
Operation
Protocol
Protocol
Constants
Protocol
Parameter
Quote
Quote
Short
Raw
Json
Register
Constant
Operation
Related
Contract
Reveal
Operation
Revelation
Penalty
Operation
Reward
Split
Select
Parameter
Selection
Parameter
Set
Deposits
Limit
Operation
Software
Software
Alias
Sort
Mode
Sort
Parameter
Source
Operation
Split
Delegator
State
Statistics
Storage
Record
String
Parameter
Symbols
Timestamp
Parameter
Token
Token
Balance
Token
Balance
Short
Token
Info
Token
Standard
Parameter
Token
Transfer
Transaction
Operation
Transfer
Ticket
Operation
Tx
Parameter
Tx
Rollup
Commit
Operation
Tx
Rollup
Dispatch
Tickets
Operation
Tx
Rollup
Finalize
Commitment
Operation
Tx
Rollup
Origination
Operation
Tx
Rollup
Rejection
Operation
Tx
Rollup
Remove
Commitment
Operation
Tx
Rollup
Return
Bond
Operation
Tx
Rollup
Submit
Batch
Operation
Update
Consensus
Key
Operation
Vdf
Revelation
Operation
Vote
Parameter
Voter
Snapshot
Voter
Status
Parameter
Voting
Epoch
Voting
Period
defaults
servers
accounts
Get
accounts
Get
Balance
accounts
Get
Balance
At
Date
accounts
Get
Balance
At
Level
accounts
Get
Balance
History
accounts
Get
Balance
Report
accounts
Get
By
Address
accounts
Get
Contracts
accounts
Get
Count
accounts
Get
Counter
accounts
Get
Delegators
accounts
Get
Operations
big
Maps
Get
Big
Map
By
Id
big
Maps
Get
Big
Map
Type
big
Maps
Get
Big
Map
Updates
big
Maps
Get
Big
Maps
big
Maps
Get
Big
Maps
Count
big
Maps
Get
Historical
Keys
big
Maps
Get
Key
big
Maps
Get
Key2
big
Maps
Get
Key
Updates
big
Maps
Get
Keys
blocks
Get
blocks
Get
By
Date
blocks
Get
By
Date2
blocks
Get
By
Hash
blocks
Get
By
Level
blocks
Get
By
Level2
blocks
Get
Count
commitments
Get
commitments
Get
All
commitments
Get
Count
constants
Get
constants
Get
By
Address
constants
Get
Count
contracts
Build
Entrypoint
Parameters
Get
contracts
Build
Entrypoint
Parameters
Post
contracts
Get
contracts
Get
Big
Map
By
Name
contracts
Get
Big
Map
By
Name
Keys
contracts
Get
Big
Maps
contracts
Get
By
Address
contracts
Get
Code
contracts
Get
Contract
View
By
Name
contracts
Get
Contract
Views
contracts
Get
Count
contracts
Get
Entrypoint
By
Name
contracts
Get
Entrypoints
contracts
Get
Historical
Keys
contracts
Get
Interface
contracts
Get
Key
contracts
Get
Key2
contracts
Get
Key
Updates
contracts
Get
Raw
Storage
contracts
Get
Raw
Storage
History
contracts
Get
Raw
Storage
Schema
contracts
Get
Same
contracts
Get
Similar
contracts
Get
Storage
contracts
Get
Storage
History
contracts
Get
Storage
Schema
cycles
Get
cycles
Get
By
Index
cycles
Get
Count
delegates
Get
delegates
Get
By
Address
delegates
Get
Count
domains
Get
domains
Get
By
Name
domains
Get
Count
events
Get
Contract
Events
events
Get
Contract
Events
Count
head
Get
helpers
Post
Inject
helpers
Post
Run
Script
View
operations
Get
Activation
By
Hash
operations
Get
Activations
operations
Get
Activations
Count
operations
Get
Baking
operations
Get
Baking
By
Id
operations
Get
Baking
Count
operations
Get
Ballot
By
Hash
operations
Get
Ballots
operations
Get
Ballots
Count
operations
Get
By
Hash
operations
Get
By
Hash
Counter
operations
Get
By
Hash
Counter
Nonce
operations
Get
Delegation
By
Hash
operations
Get
Delegation
Status
operations
Get
Delegations
operations
Get
Delegations
Count
operations
Get
Double
Baking
operations
Get
Double
Baking
By
Hash
operations
Get
Double
Baking
Count
operations
Get
Double
Endorsing
operations
Get
Double
Endorsing
By
Hash
operations
Get
Double
Endorsing
Count
operations
Get
Double
Preendorsing
operations
Get
Double
Preendorsing
By
Hash
operations
Get
Double
Preendorsing
Count
operations
Get
Drain
Delegate
By
Hash
operations
Get
Drain
Delegate
Ops
operations
Get
Drain
Delegate
Ops
Count
operations
Get
Endorsement
By
Hash
operations
Get
Endorsements
operations
Get
Endorsements
Count
operations
Get
Endorsing
Reward
By
Id
operations
Get
Endorsing
Rewards
operations
Get
Endorsing
Rewards
Count
operations
Get
Increase
Paid
Storage
By
Hash
operations
Get
Increase
Paid
Storage
Count
operations
Get
Increase
Paid
Storage
Ops
operations
Get
Migration
By
Id
operations
Get
Migrations
operations
Get
Migrations
Count
operations
Get
Nonce
Revelation
By
Hash
operations
Get
Nonce
Revelations
operations
Get
Nonce
Revelations
Count
operations
Get
Origination
By
Hash
operations
Get
Origination
Status
operations
Get
Originations
operations
Get
Originations
Count
operations
Get
Preendorsement
By
Hash
operations
Get
Preendorsements
operations
Get
Preendorsements
Count
operations
Get
Proposal
By
Hash
operations
Get
Proposals
operations
Get
Proposals
Count
operations
Get
Register
Constant
By
Hash
operations
Get
Register
Constant
Status
operations
Get
Register
Constants
operations
Get
Register
Constants
Count
operations
Get
Reveal
By
Hash
operations
Get
Reveal
Status
operations
Get
Reveals
operations
Get
Reveals
Count
operations
Get
Revelation
Penalties
operations
Get
Revelation
Penalties
Count
operations
Get
Revelation
Penalty
By
Id
operations
Get
Set
Deposits
Limit
By
Hash
operations
Get
Set
Deposits
Limit
Status
operations
Get
Set
Deposits
Limits
operations
Get
Set
Deposits
Limits
Count
operations
Get
Status
operations
Get
Transaction
By
Hash
operations
Get
Transaction
By
Hash
Counter
operations
Get
Transaction
By
Hash
Counter
Nonce
operations
Get
Transaction
Status
operations
Get
Transactions
operations
Get
Transactions
Count
operations
Get
Transfer
Ticket
Ops
operations
Get
Transfer
Ticket
Ops
By
Hash
operations
Get
Transfer
Ticket
Ops
Count
operations
Get
Transfer
Ticket
Status
operations
Get
Tx
Rollup
Commit
Ops
operations
Get
Tx
Rollup
Commit
Ops
By
Hash
operations
Get
Tx
Rollup
Commit
Ops
Count
operations
Get
Tx
Rollup
Commit
Status
operations
Get
Tx
Rollup
Dispatch
Tickets
Ops
operations
Get
Tx
Rollup
Dispatch
Tickets
Ops
By
Hash
operations
Get
Tx
Rollup
Dispatch
Tickets
Ops
Count
operations
Get
Tx
Rollup
Dispatch
Tickets
Status
operations
Get
Tx
Rollup
Finalize
Commitment
Ops
operations
Get
Tx
Rollup
Finalize
Commitment
Ops
By
Hash
operations
Get
Tx
Rollup
Finalize
Commitment
Ops
Count
operations
Get
Tx
Rollup
Finalize
Commitment
Status
operations
Get
Tx
Rollup
Origination
Ops
operations
Get
Tx
Rollup
Origination
Ops
By
Hash
operations
Get
Tx
Rollup
Origination
Ops
Count
operations
Get
Tx
Rollup
Origination
Status
operations
Get
Tx
Rollup
Rejection
Ops
operations
Get
Tx
Rollup
Rejection
Ops
By
Hash
operations
Get
Tx
Rollup
Rejection
Ops
Count
operations
Get
Tx
Rollup
Rejection
Status
operations
Get
Tx
Rollup
Remove
Commitment
Ops
operations
Get
Tx
Rollup
Remove
Commitment
Ops
By
Hash
operations
Get
Tx
Rollup
Remove
Commitment
Ops
Count
operations
Get
Tx
Rollup
Remove
Commitment
Status
operations
Get
Tx
Rollup
Return
Bond
Ops
operations
Get
Tx
Rollup
Return
Bond
Ops
By
Hash
operations
Get
Tx
Rollup
Return
Bond
Ops
Count
operations
Get
Tx
Rollup
Return
Bond
Status
operations
Get
Tx
Rollup
Submit
Batch
Ops
operations
Get
Tx
Rollup
Submit
Batch
Ops
By
Hash
operations
Get
Tx
Rollup
Submit
Batch
Ops
Count
operations
Get
Tx
Rollup
Submit
Batch
Status
operations
Get
Update
Consensus
Key
By
Hash
operations
Get
Update
Consensus
Key
Ops
operations
Get
Update
Consensus
Key
Ops
Count
operations
Get
Vdf
Revelation
By
Hash
operations
Get
Vdf
Revelations
operations
Get
Vdf
Revelations
Count
protocols
Get
protocols
Get
By
Code
protocols
Get
By
Cycle
protocols
Get
By
Hash
protocols
Get
Count
protocols
Get
Current
quotes
Get
quotes
Get
Count
quotes
Get
Last
rewards
Get
Baker
Rewards
rewards
Get
Baker
Rewards
By
Cycle
rewards
Get
Baker
Rewards
Count
rewards
Get
Delegator
Rewards
rewards
Get
Delegator
Rewards
By
Cycle
rewards
Get
Delegator
Rewards
Count
rewards
Get
Reward
Split
rewards
Get
Reward
Split
Delegator
rights
Get
rights
Get
Count
software
Get
software
Get
Count
statistics
Get
statistics
Get
Cycles
statistics
Get
Cycles
All
statistics
Get
Daily
tokens
Get
Token
Balances
tokens
Get
Token
Balances2
tokens
Get
Token
Balances
Count
tokens
Get
Token
Transfers
tokens
Get
Token
Transfers
Count
tokens
Get
Tokens
tokens
Get
Tokens
Count
voting
Get
Current
Epoch
voting
Get
Current
Period
voting
Get
Epoch
voting
Get
Epochs
voting
Get
Latest
Voting
voting
Get
Period
voting
Get
Period
Voter
voting
Get
Period
Voter2
voting
Get
Period
Voters
voting
Get
Period
Voters2
voting
Get
Periods
voting
Get
Proposal
By
Hash
voting
Get
Proposals
voting
Get
Proposals
Count
Generated using
TypeDoc
Get JSON Schema [2020-12] interface for the contract