# sui_getMoveFunctionArgTypes

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

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

Returns the list of argument types for a specified Move function within a Move module. The response is based on the normalized types, and includes descriptors like "Pure" or "Object" with reference semantics.


Reference: https://www.alchemy.com/docs/chains/sui/sui-api-endpoints/sui-get-move-function-arg-types

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| package | string | Yes | The package object ID of the Move module. |
| module | string | Yes | The name of the Move module. |
| function | string | Yes | The name of the Move function. |

## Result

**result** (enum or object[]): A list of argument types expected by the Move function.

## Example

### Request

```json
{
  "jsonrpc": "2.0",
  "method": "sui_getMoveFunctionArgTypes",
  "params": [
    "0x0000000000000000000000000000000000000000000000000000000000000002",
    "bag",
    "borrow"
  ],
  "id": 1
}
```

### Response

```json
{
  "jsonrpc": "2.0",
  "result": [
    {
      "Object": "ByImmutableReference"
    },
    "Pure"
  ],
  "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": "sui_getMoveFunctionArgTypes",
  "params": [
    "0x0000000000000000000000000000000000000000000000000000000000000002",
    "bag",
    "borrow"
  ]
}'
```

### JavaScript

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

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": "sui_getMoveFunctionArgTypes",
    "params": ["0x0000000000000000000000000000000000000000000000000000000000000002", "bag", "borrow"]
}
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\": \"sui_getMoveFunctionArgTypes\",\n  \"params\": [\n    \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n    \"bag\",\n    \"borrow\"\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\": \"sui_getMoveFunctionArgTypes\",\n  \"params\": [\n    \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n    \"bag\",\n    \"borrow\"\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\": \"sui_getMoveFunctionArgTypes\",\n  \"params\": [\n    \"0x0000000000000000000000000000000000000000000000000000000000000002\",\n    \"bag\",\n    \"borrow\"\n  ]\n}", false);
var response = await client.PostAsync(request);

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

```


## OpenRPC Method Specification

```yaml
name: sui_getMoveFunctionArgTypes
summary: Get argument types of a Move function
description: |
  Returns the list of argument types for a specified Move function within a Move module. The response is based on the normalized types, and includes descriptors like "Pure" or "Object" with reference semantics.
params:
  - name: package
    required: true
    description: The package object ID of the Move module.
    schema:
      type: string
  - name: module
    required: true
    description: The name of the Move module.
    schema:
      type: string
  - name: function
    required: true
    description: The name of the Move function.
    schema:
      type: string
result:
  name: result
  description: A list of argument types expected by the Move function.
  schema:
    type: array
    items:
      oneOf:
        - type: string
          enum:
            - Pure
        - type: object
          properties:
            Object:
              type: string
              enum:
                - ByImmutableReference
                - ByMutableReference
                - ByValue
examples:
  - name: Get Move function argument types
    params:
      - name: package
        value: '0x0000000000000000000000000000000000000000000000000000000000000002'
      - name: module
        value: bag
      - name: function
        value: borrow
    result:
      name: result
      value:
        - Object: ByImmutableReference
        - Pure
```
