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

❗️

Deprecated RPCs

The getAddressSummary and getUTXO RPCs are deprecated and no longer usable as of Dash Platform v0.15.0.

Services that previously used these RPCs should join the wallet-lib library in switching to using the subscribeToTransactionsWithProofs gRPC endpoint for similar (and more efficient) functionality.

Layer	Endpoint	Description
1	getAddressSummary	Deprecated in Dash Platform v0.15.0 Returns summary information for provided address(es)
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
1	getUTXO	Deprecated in Dash Platform v0.15.0 Returns unspent transaction outputs for a given address

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	sendTransaction	Renamed to broadcastTransaction in Dash Platform v0.15.0
1	subscribeTo TransactionsWithProofs	Returns transactions matching the provided bloom filter along with the associated islock message and merkle block

Platform gRPC Service

❗️

Deprecated RPCs

The getIdentityByFirstPublicKey and getIdentityIdByFirstPublicKey RPCs are deprecated and no longer usable as of Dash Platform v0.16.0. They were replaced by getIdentitiesByPublicKeyHashes and getIdentityIdsByPublicKeyHashes.

Layer	Endpoint
2	applyStateTransition	Renamed to broadcastStateTransition in Dash Platform v0.15.0
2	broadcastStateTransition	Broadcasts the provided State Transition
2	getIdentity	Returns the requested identity
2	getIdentityByFirstPublicKey	Returns the identity associated with the provided public key (replaced by getIdentitiesByPublicKeyHashes)
2	getIdentityIdByFirstPublicKey	Returns the identity ID associated with the provided public key (replaced by getIdentityIdsByPublicKeyHashes)
2	getIdentitiesByPublicKeyHashes	Returns the identities associated with the provided public key hashes Added in Dash Platform v0.16
2	getIdentityIdsByPublicKeyHashes	Returns the identity IDs associated with the provided public key hashes Added in Dash Platform v0.16
2	getDataContract	Returns the requested data contract
2	getDocuments	Returns the requested document(s)