DAPI Endpoints

Overview of available endpoints

DAPI currently provides 2 types of endpoints: JSON-RPC and gRPC. The JSON-RPC endpoints expose some layer 1 information while the gRPC endpoints support layer 2 as well as streaming of events related to blocks and transactions/transitions.

JSON-RPC Endpoints

📘

gRPC Migration

The remaining JSON-RPC endpoints will be migrated to gRPC in a future release

Layer	Endpoint	Description
1	getBestBlockHash	Returns block hash of the chaintip
1	getBlockHash	Returns block hash of the requested block
1	getMnListDiff	Returns masternode list diff for the provided block hashes

gRPC Endpoints

Core gRPC Service

Layer	Endpoint
1	broadcastTransaction	Broadcasts the provided transaction
1	getBlock	Returns information for the requested block
1	getStatus	Returns blockchain status information
1	getTransaction	Returns details for the requested transaction
1	subscribeTo BlockHeadersWithChainLocks	Returns the requested block headers along with the associated ChainLocks. Added in Dash Platform v0.22
1	subscribeTo TransactionsWithProofs	Returns transactions matching the provided bloom filter along with the associated islock message and merkle block

Platform gRPC Service

📘

Response Proofs

Dash Platform 0.20.0 introduced proofs to Platform gRPC endpoints so the data returned for a request can be verified as being valid.

Layer	Endpoint
2	broadcastStateTransition	Broadcasts the provided State Transition
2	getIdentity	Returns the requested identity
2	getIdentitiesByPublicKeyHashes	Returns the identities associated with the provided public key hashes Added in Dash Platform v0.16
2	getIdentityIdsByPublicKeyHashes	Removed in Dash Platform v0.23 Returns the identity IDs associated with the provided public key hashes
2	getDataContract	Returns the requested data contract
2	getDocuments	Returns the requested document(s)
2	waitForStateTransitionResult	Responds with the state transition hash and either a proof that the state transition was confirmed in a block or an error

📘

The previous version of documentation can be viewed here.