LogoLogo
1.3.x
1.3.x
  • Documentation
    • Introduction
    • Overview
      • Authorization
      • Rate limits and quotas
      • Pagination
      • Sorting
      • Filtering
      • Optional properties
      • Errors
    • Getting started
    • Highlights
      • Including related entities
      • Including CSPR rates
      • Including account info
      • Accessing auction data
      • Accessing token data
      • Accessing NFT data
      • De-anonymizing account hashes
      • De-anonymizing account purses
      • Receiving contract-level events
    • Changelog
  • REST API
    • Reference
    • Account
      • Get account
      • Get accounts
    • Account Info
      • Get account info
      • Get account infos
    • Auction metrics
      • Get auction metrics
    • Awaiting deploy
      • Create Awaiting Deploy
      • Add Awaiting Deploy signatures
      • Get Awaiting Deploy
    • Block
      • Get block
      • Get blocks
      • Get validator blocks
    • Bidder
      • Get bidder
      • Get bidders
    • Centralized account info
      • Get centralized account info
      • Get centralized account infos
    • Contract
      • Get contract
      • Get contracts
      • Get contracts by contract package
      • Get contract types
    • Contract entry point
      • Get contract entry points
      • Get contract entry point costs
    • Contract package
      • Get contract package
      • Get contract packages
      • Get account contract packages
    • Delegation
      • Get account delegations
      • Get validator delegations
    • Delegator reward
      • Get account delegator rewards
      • Get total account delegation rewards
      • Get total validator delegators' rewards
    • Deploy
      • Get deploy
      • Get deploys
      • Get account deploys
      • Get block deploys
      • Get deploy execution types
    • Fungible token action
      • Get fungible token actions
      • Get fungible token action types
      • Get account fungible token actions
      • Get contract package fungible token actions
    • Fungible token ownership
      • Get account fungible token ownership
      • Get contract package fungible token ownership
    • Non-fungible token (NFT)
      • Get NFT
      • Get account NFTs
      • Get contract package NFTs
      • Get NFT standards
      • Get off-chain NFT metadata statuses
    • Non-fungible token (NFT) action
      • Get contract package NFT actions for a token
      • Get account NFT actions
      • Get contract package NFT actions
      • Get NFT action types
    • Non-fungible token (NFT) ownership
      • Get contract package NFT ownership
      • Get account NFT ownership
    • CSPR rate
      • Get the current currency rate
      • Get historical currency rates
      • Get currencies
    • CSPR supply
      • Get supply
    • Transfer
      • Get account transfers
      • Get deploy transfers
    • Validator
      • Get validator
      • Get validators
    • Validator performance
      • Get historical validator performance
      • Get historical average validator performance
      • Get historical average validators performance
    • Validator reward
      • Get validator rewards
      • Get validator total rewards
  • Streaming API
    • Reference
    • Account balance
    • Block
    • Contract
    • Contract package
    • Contract-level events
    • Deploy
    • Fungible token action
    • Non-fungible token (NFT)
    • Non-fungible token (NFT) action
    • Transfer
  • Casper Node API
    • Connecting with an SDK
Powered by GitBook
On this page
  • Properties
  • Optional properties
  • Relations
  • Endpoints
  • Relation endpoints
Export as PDF
  1. REST API

Transfer

PreviousGet supplyNextGet account transfers

Last updated 8 months ago

The Transfer entity represents a successful native token (CSPR) transfer on the Casper network. Transfers are tracked from the transforms found in the deploy execution results.

Properties

The Transfer entity has the following properties:

Property
Type
Description

id

uint64

Transfer identifier provided by the deploy caller if the deploy is a native transfer. Default is 0.

deploy_hash

string(64)

Deploy hash represented as a hexadecimal string

block_height

uint64

Height of the block in which the transfer happened

transform_key

string(64)

initiator_account_hash

string(64)

Deploy caller account hash represented as a hexadecimal string

from_purse

string(73)

Source purse URef in the uref-dead...beef-007 format

to_purse

string(73)

Target purse URef in the uref-dead...beef-007 format

to_account_hash

string(64)

Transfer recipient account hash represetnted as a hexadecimal string

amount

string

Transfer amount in motes. The type is string to avoid overflow in languages that don't support uint64, which is the correct type.

timestamp

string

Example

{
  "amount": "999900000000",
  "deploy_hash": "00002856709bb267fefac532afa41fdb7b66af0521b344dd218f0386b725bcfc",
  "block_height": 2404577,
  "from_purse": "uref-1fba1ec9ab80f4df6d4dd2b9963fc0e8bcd3e3ae2479bd89133213398f463f8b-007",
  "id": 1674228372106,
  "initiator_account_hash": "d1e7f6267837c30c7e3356f049836b5db71ab10f023ddb00e6ab0bd960bf7e4d",
  "timestamp": "2023-01-20T15:26:34Z",
  "to_account_hash": "11f03518b71ba8ac0e6087d1a2b0a82a97de66f640ae77e661ce80e365196a24",
  "to_purse": "uref-6ccb3f9c96957eae5c0f2d4d1106926bcf5ab5a2690a3f07da9603d8236e3e26-004",
  "transform_key": "ab152ea01deca92473828fff439d6b8498397a7cceaff059e12d2aa2fe3f5ce5"
}

Optional properties

Depending on the endpoint some of the following optional properties may be included in the Transfer entity:

Property
Type
Description

initiator_public_key

string(68)

Initiator public key represented as a hexademical string

to_public_key

string(68)

Transfer recipient public key represented as a hexademical string

from_purse_public_key

string(68)

Public key of the account that owns the transfer source purse represented as a hexademical string. null when the sender purse is not own by an account

to_purse_public_key

string(68)

Public key of the account that owns the transfer target purse represented as a hexademical string. null when the target purse is not own by an account

to_account_info

Transfer recipient account info

to_centralized_account_info

Transfer recipient centralized account info

from_purse_account_info

Account info of the account that owns the transfer source purse. null when the sender purse is not own by an account

from_purse_centralized_account_info

Centralized account info that owns the transfer source purse. null when the sender purse is not own by an account

to_purse_account_info

Account info of the account that owns the transfer target purse. null when the target purse is not own by an account

to_purse_centralized_account_info

Centralized account info of the account that owns the transfer target purse. null when the target purse is not own by an account

initiator_public_key

string(68)

Deploy caller public key represented as a hexadecimal string

rate

float32

CSPR rate for specified currency that was relevant at the moment of deploy creation

Relations

The Transfer entity has the following relations with other entities:

Entity
Mapping property
Description

initiator_account_hash, to_account_hash

Accounts can send and receive transfers

deploy_hash

Transfers are results of deploy execution

Endpoints

The Transfer entity has the following endpoints:

Relation endpoints

None

transform key represented as a hexademical string

Deploy creation timestmap in the format

WriteTransfer
Get account transfers
Get deploy transfers
WriteTransfer
ISO 8601
AccountInfo
CentralizedAccountInfo
AccountInfo
CentralizedAccountInfo
AccountInfo
CentralizedAccountInfo
Account
Deploy