Console

gRPCGetCoinInfo

sui-mainnet.nodit.io:443 sui.rpc.v2.StateService/GetCoinInfounary

Retrieves the metadata and treasury information for the specified coin type.

TransportgRPC

Request and response messages are identical for both transports. Only the wire protocol, headers, and client library differ.

Protocol
Native gRPC over HTTP/2 with TLS. Suited to server-side clients and grpcurl.
Content-Type
application/grpc
Headers
x-api-key
Streaming
Server, client, and bidirectional streaming are all supported.
Errors
grpc-status and grpc-message are delivered as HTTP/2 trailers.
Request Body
coin_typestring

The coin type to request information about.

Responses
coin_typestring

Required. The coin type.

idstring

CoinMetadata or Currency ObjectId.

decimalsinteger

Number of decimal places.

namestring

Token name.

symbolstring

Token symbol.

descriptionstring

Description of the coin.

icon_urlstring

Logo/icon URL.

metadata_cap_idstring

MetadataCap ObjectId.

metadata_cap_statestring

State of the metadata cap.

idstring

TreasuryCap ObjectId.

total_supplyinteger

Total supply of the coin.

supply_statestring

State of the supply.

idstring

RegulatedCoinMetadata ObjectId.

coin_metadata_objectstring

CoinMetadata or CoinData ID.

deny_cap_objectstring

DenyCap ID.

allow_global_pauseboolean

Whether global pause is allowed.

variantinteger

Variant of the regulated metadata.

coin_regulated_statestring

Regulated state of the coin.

X-API-KEY
RequestCU10
grpcurl
grpcurl \
  -import-path . -proto sui/rpc/v2/state_service.proto \
  -H "X-API-KEY: {YOUR_API_KEY}" \
  -d '{
  "coin_type": "0x2::sui::SUI"
}' \
  sui-mainnet.nodit.io:443 sui.rpc.v2.StateService/GetCoinInfo
Response
Example · 200
{
  "coin_type": "0x2::sui::SUI",
  "metadata": {},
  "treasury": {},
  "regulated_metadata": {}
}

Last updated