# suix_getCoinMetadata

> For the complete documentation index, see [llms.txt](/docs/llms.txt).

POST https://sui-mainnet.g.alchemy.com/v2/{apiKey}

Retrieves metadata (name, symbol, decimals, etc.) for a given coin type.

Reference: https://www.alchemy.com/docs/chains/sui/sui-api-endpoints/suix-get-coin-metadata

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| coinType | string | Yes | The Move type of the coin (e.g. `0x2::sui::SUI`) |

## Result

**result** (object): Metadata about the requested coin.

## Example

### Request

```json
{
  "jsonrpc": "2.0",
  "method": "suix_getCoinMetadata",
  "params": [
    "0x2::sui::SUI"
  ],
  "id": 1
}
```

### Response

```json
{
  "jsonrpc": "2.0",
  "result": {
    "decimals": 9,
    "name": "Sui",
    "symbol": "SUI",
    "description": "",
    "iconUrl": null,
    "id": "0x9258181f5ceac8dbffb7030890243caed69a9599d2886d957a9cb7656af3bdb3"
  },
  "id": 1
}
```

## Code Examples

### cURL

```bash
curl --request POST \
  --url https://sui-mainnet.g.alchemy.com/v2/docs-demo \
  --header 'Content-Type: application/json' \
  --data '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "suix_getCoinMetadata",
  "params": [
    "0x2::sui::SUI"
  ]
}'
```

### JavaScript

```javascript
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'suix_getCoinMetadata',
    params: ['0x2::sui::SUI']
  })
};

fetch('https://sui-mainnet.g.alchemy.com/v2/docs-demo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://sui-mainnet.g.alchemy.com/v2/docs-demo"

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "suix_getCoinMetadata",
    "params": ["0x2::sui::SUI"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

### Go

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sui-mainnet.g.alchemy.com/v2/docs-demo"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_getCoinMetadata\",\n  \"params\": [\n    \"0x2::sui::SUI\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

### Java

```java
HttpResponse<String> response = Unirest.post("https://sui-mainnet.g.alchemy.com/v2/docs-demo")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_getCoinMetadata\",\n  \"params\": [\n    \"0x2::sui::SUI\"\n  ]\n}")
  .asString();
```

### C#

```csharp
using RestSharp;


var options = new RestClientOptions("https://sui-mainnet.g.alchemy.com/v2/docs-demo");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"suix_getCoinMetadata\",\n  \"params\": [\n    \"0x2::sui::SUI\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

```


## OpenRPC Method Specification

```yaml
name: suix_getCoinMetadata
summary: Get metadata for a specific coin
description: Retrieves metadata (name, symbol, decimals, etc.) for a given coin type.
params:
  - name: coinType
    required: true
    description: The Move type of the coin (e.g. `0x2::sui::SUI`)
    schema:
      type: string
result:
  name: result
  description: Metadata about the requested coin.
  schema:
    type: object
    properties:
      decimals:
        type: integer
        description: Number of decimals the coin uses.
      name:
        type: string
        description: Full name of the coin.
      symbol:
        type: string
        description: Coin symbol or ticker.
      description:
        type: string
        description: Optional description for the coin.
      iconUrl:
        type: string
        nullable: true
        description: Optional icon URL.
      id:
        type: string
        description: Unique ID of the coin metadata object.
examples:
  - name: Metadata for SUI coin
    params:
      - name: coinType
        value: 0x2::sui::SUI
    result:
      name: result
      value:
        decimals: 9
        name: Sui
        symbol: SUI
        description: ''
        iconUrl: null
        id: '0x9258181f5ceac8dbffb7030890243caed69a9599d2886d957a9cb7656af3bdb3'
```