Venly

https://docs.venly.io/
Admin
Venly is a developer platform offering APIs and SDKs for blockchain applications, enabling secure...
Tokens:2,027,437
Snippets:5,893
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Minting an NFT (HTTP)

Source: https://docs.venly.io/v2.0/docs/nft-api-getting-started

This example shows the HTTP POST request endpoint for minting NFTs via the Venly API. It is used to initiate the NFT minting process.

```http
 POST /api/v2/contracts/deployments
```

--------------------------------

### Check ERC20 Token Mint Status Example (HTTP)

Source: https://docs.venly.io/docs/token-api-getting-started

An example of an HTTP GET request to retrieve the status of a specific ERC20 token mint request, using a provided mint ID.

```HTTP
GET /api/v3/erc20/tokens/mints/273e6ecb-fb1b-44f0-a9ff-a19bbf92099a
```

--------------------------------

### Create Token-Type Response Body Example (JSON)

Source: https://docs.venly.io/docs/nft-api-getting-started

This is an example of the JSON response body received after submitting a request to create a token-type. It includes a success status, creation ID, token type ID, and metadata for the created token.

```json
{
    "success": true,
    "result": {
        "creations": [
            {
                "id": "92ebfbb7-df9a-4228-9b57-6614315fc896",
                "status": "PENDING",
                "tokenTypeId": 1,
                "metadata": {
                    "name": "Zap Village",
                    "description": "Enter the Venly Zap Village!",
                    "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
                    "imagePreview": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
                    "imageThumbnail": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
                    "animationUrls": [],
                    "attributes": [
                        {
                            "type": "system",
                            "name": "tokenTypeId",
                            "value": "1",
                            "traitType": "Token Type ID",
                            "trait_type": "Token Type ID"
                        }
                    ],
                    "contract": {
                        "address": "0xf0b30ec3720e9be1452b64d2ee476f57c2f535d3",
                        "name": "Venly NFT Collection",
                        "symbol": "VENFCO",
                        "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                        "imageUrl": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                        "image_url": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                        "description": "This collection contains Venly NFTs.",
                        "externalLink": "https://www.venly.io/",
                        "external_link": "https://www.venly.io/",
                        "externalUrl": "https://www.venly.io/",
                        "external_url": "https://www.venly.io/",
                        "media": [],
                        "type": "ERC_1155"
                    },
                    "fungible": false
                }
            }
        ]
    }
}
```

--------------------------------

### Create Token-Type Request Body Example (JSON)

Source: https://docs.venly.io/docs/nft-api-getting-started

This is an example of the JSON request body used to create a new token-type. It specifies the blockchain, contract address, and details for the token creations, including name, description, and image.

```json
{
    "chain": "MATIC",
    "contractAddress": "0xf0b30ec3720e9be1452b64d2ee476f57c2f535d3",
    "creations": [
        {
            "name": "Zap Village",
            "description": "Enter the Venly Zap Village!",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg"
        }
    ]
}
```

--------------------------------

### POST /api/v2/contracts/deployments

Source: https://docs.venly.io/v2.0/docs/nft-api-getting-started

Creates a new NFT contract (collection) on a specified blockchain. This endpoint is essential for setting up your NFT collection before minting individual NFTs.

```APIDOC
## POST /api/v2/contracts/deployments

### Description
Creates a new NFT contract (collection) on a specified blockchain. This endpoint is essential for setting up your NFT collection before minting individual NFTs.

### Method
POST

### Endpoint
`https://nft-api-sandbox.venly.io/api/v2/contracts/deployments`

### Parameters
#### Request Body
- **name** (String) - Required - The name of your NFT collection/contract
- **description** (String) - Required - The description of your NFT collection/contract
- **image** (String) - Required - The image URL for your NFT collection/contract that will be displayed
- **externalUrl** (String) - Required - This can be any link such as a link to your website, landing page, etc.
- **chain** (String) - Required - This is the blockchain on which you want to create the contract on (e.g., MATIC)

### Request Example
```json
{
  "name": "NFT Collection",
  "description": "Sample description",
  "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
  "externalUrl": "www.venly.io",
  "chain": "MATIC"
}
```

### Response
#### Success Response (200)
- **contractId** (String) - The unique identifier for the deployed contract.
- **status** (String) - The status of the contract deployment (e.g., "PENDING", "SUCCESS", "FAILED").

#### Response Example
```json
{
  "contractId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "PENDING"
}
```
```

--------------------------------

### Create Token Contract

Source: https://docs.venly.io/docs/token-api-getting-started

Defines and deploys a new ERC20 token contract on the MATIC testnet.

```APIDOC
## POST /api/v3/erc20/contracts/deployments

### Description
Deploys a new ERC20 token contract on the MATIC testnet.

### Method
POST

### Endpoint
/api/v3/erc20/contracts/deployments

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
**name** (string) - Required - The name of the token.
**symbol** (string) - Required - The symbol of the token.
**supply** (integer) - Required - The total supply of the token.
**ownerAddress** (string) - Required - The wallet address of the token owner.

### Request Example
```json
{
  "name": "MyToken",
  "symbol": "MTK",
  "supply": 1000000,
  "ownerAddress": "0xYourWalletAddress"
}
```

### Response
#### Success Response (200)
- **contractId** (string) - The unique identifier for the deployed contract.
- **status** (string) - The deployment status of the contract.

#### Response Example
```json
{
  "contractId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "PENDING"
}
```
```

--------------------------------

### Minting an NFT

Source: https://docs.venly.io/v2.0/docs/nft-api-getting-started

This endpoint is used for minting NFTs. It initiates the process of deploying contracts and minting tokens.

```APIDOC
## POST /api/v2/contracts/deployments

### Description
This endpoint is used for minting NFTs. It initiates the process of deploying contracts and minting tokens.

### Method
POST

### Endpoint
/api/v2/contracts/deployments

### Parameters
*(Request body details for this endpoint are not provided in the input text.)*

### Request Example
*(Request example for this endpoint is not provided in the input text.)*

### Response
#### Success Response (200)
*(Success response details for this endpoint are not provided in the input text.)*

#### Response Example
*(Response example for this endpoint is not provided in the input text.)*
```

--------------------------------

### POST /api/v3/erc1155/contracts/deployments

Source: https://docs.venly.io/docs/nft-api-getting-started

This endpoint allows you to mint NFTs for a specified token type and contract. You provide the contract details, the token type ID, and a list of destinations with the amount of NFTs to mint for each.

```APIDOC
## POST /api/v3/erc1155/contracts/deployments

### Description
This endpoint allows you to mint NFTs for a specified token type and contract. You provide the contract details, the token type ID, and a list of destinations with the amount of NFTs to mint for each.

### Method
POST

### Endpoint
/api/v3/erc1155/contracts/deployments

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **contractAddress** (String) - Required - The contract address
- **chain** (String) - Required - The blockchain of the contract
- **tokenTypeId** (String) - Required - The ID of the token-type. You can get it from the response body when you create a token-type.
- **destinations** (Array of objects) - Required - The array which includes all the wallet addresses and the number of NFTs to mint per wallet address
  - **destinations.address** (String) - Required - The wallet address to mint and send the NFT. This can be a wallet address or an email address.
  - **destinations.amount** (Integer) - Required - The number of NFTs you want to mint and send.

### Request Example
```json
{
    "contractAddress": "0xf0b30ec3720e9be1452b64d2ee476f57c2f535d3",
    "chain": "MATIC",
    "tokenTypeId": "2",
    "destinations": [
        {
            "address": "0x9A9F6A560bBdCFbbb014303fc817D1e5EeaA3AE2",
            "amount": 1
        }
    ]
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains the result of the minting operation.
  - **result.id** (String) - The unique identifier for the minting operation.
  - **result.status** (String) - The status of the minting operation. Possible values: `SUCCEEDED`, `PENDING`, `FAILED`.
  - **result.transactionHash** (String) - The transaction hash on the blockchain if the operation was successful.
  - **result.tokenTypeId** (Integer) - The ID of the token type that was minted.
  - **result.mints** (Array) - An array of mint details (empty in this example).
  - **result.metadata** (Object) - Metadata associated with the minted NFT.

#### Response Example
```json
{
    "success": true,
    "result": {
        "id": "ff81e5e5-68eb-4ba1-949d-b82d9adf30ad",
        "status": "SUCCEEDED",
        "transactionHash": "0x892a5740a0a2ae77a79218beb4891411b3f9e12fb54c59f0e044b6157e22ba66",
        "tokenTypeId": 2,
        "mints": [],
        "metadata": {
            "name": "Zap Village",
            "description": "Enter the Venly Zap Village!",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
            "imagePreview": "https://storage-staging.staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
            "imageThumbnail": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/purplevillage.jpeg",
            "animationUrls": [],
            "attributes": [
                {
                    "type": "system",
                    "name": "tokenTypeId",
                    "value": "2",
                    "traitType": "Token Type ID",
                    "trait_type": "Token Type ID"
                }
            ],
            "contract": {
                "address": "0xf0b30ec3720e9be1452b64d2ee476f57c2f535d3",
                "name": "Venly NFT Collection",
                "symbol": "VENFCO",
                "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                "imageUrl": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                "image_url": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
                "description": "This collection contains Venly NFTs.",
                "externalLink": "https://www.venly.io/",
                "external_link": "https://www.venly.io/",
                "externalUrl": "https://www.venly.io/",
                "external_url": "https://www.venly.io/",
                "media": [],
                "type": "ERC_1155"
            },
            "fungible": false
        }
    }
}
```
```

--------------------------------

### POST /api/v3/erc20/contracts/deployments

Source: https://docs.venly.io/v3.0/docs/token-api-getting-started

Deploys a new ERC20 token contract on a specified blockchain. This endpoint allows you to define the properties of your token, such as its name, symbol, and supply.

```APIDOC
## POST /api/v3/erc20/contracts/deployments

### Description
Deploys a new ERC20 token contract on a specified blockchain. You can define properties like name, symbol, and supply.

### Method
POST

### Endpoint
`/api/v3/erc20/contracts/deployments`

### Parameters
#### Request Body
- **chain** (String) - Required - The blockchain on which to create the token contract.
- **name** (String) - Required - The name of your token contract.
- **symbol** (String) - Optional - The symbol for your token contract.
- **maxSupply** (Integer) - Optional - The maximum amount of tokens allowed to be minted.
- **burnable** (Boolean) - Optional - Indicates if the tokens will be burnable.
- **owner** (String) - Optional - The wallet address that will be the owner of this token contract.

### Request Example
```json
{
    "chain": "MATIC",
    "name": "Venly Test Token",
    "symbol": "VTT",
    "maxSupply": "150",
    "burnable": "true",
    "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9"
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains details about the deployment.
  - **id** (String) - The deployment ID, used to check the status of the contract creation.
  - **chain** (String) - The blockchain where the contract is deployed.
  - **name** (String) - The name of the token contract.
  - **symbol** (String) - The symbol of the token contract.
  - **maxSupply** (Integer) - The maximum supply of the token.
  - **burnable** (Boolean) - Indicates if the token is burnable.
  - **owner** (String) - The owner address of the token contract.
  - **transactionHash** (String) - The transaction hash for the contract creation.
  - **status** (String) - The status of the transaction (e.g., PENDING).

#### Response Example
```json
{
    "success": true,
    "result": {
        "id": "22fa9617-4630-49c1-8cd2-a0145980cd21",
        "chain": "MATIC",
        "name": "Venly Test Token",
        "symbol": "VTT",
        "maxSupply": 150,
        "burnable": true,
        "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9",
        "transactionHash": "0xdaae9385afe8a9e91d2f771e1bcb3597eb563fe0ab48cd75d381ac4798ad1359",
        "status": "PENDING"
    }
}
```
```

--------------------------------

### POST /api/v3/erc20/tokens/mints

Source: https://docs.venly.io/v3.0/docs/token-api-getting-started

Mints ERC20 tokens to specified wallet addresses. Requires the blockchain, contract address, and a list of destination addresses with amounts.

```APIDOC
## POST /api/v3/erc20/tokens/mints

### Description
Mints ERC20 tokens by supplying the token contract address and destination wallet addresses.

### Method
POST

### Endpoint
/api/v3/erc20/tokens/mints

### Parameters
#### Request Body
- **chain** (String) - Required - The blockchain of the token contract.
- **contractAddress** (String) - Required - The token contract address.
- **destinations** (Array of objects) - Required - The array includes all the wallet addresses and the number of ERC20 tokens to mint per wallet address.
  - **destinations.address** (String) - Required - The wallet address to mint and send the ERC20 tokens to.
  - **destinations.amount** (Number) - Required - The number of ERC20 tokens you want to mint and send.

### Request Example
```json
{
    "chain": "MATIC",
    "contractAddress": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
    "destinations": [
        {
            "address": "0xb811Fac088E8E80F56258a5f29D47d0FF1a37BD5",
            "amount": "5"
        },
        {
            "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
            "amount": "25"
        }
    ]
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains details about the minting process.
  - **result.mints** (Array of objects) - Information about each mint request.
    - **result.mints.id** (String) - The mint ID, used to track the token mint request.
    - **result.mints.createdOn** (String) - The timestamp when the mint request was created.
    - **result.mints.status** (String) - The current status of the mint request (e.g., PENDING).
    - **result.mints.destination** (Object) - Details about the destination.
      - **result.mints.destination.address** (String) - The wallet address.
      - **result.mints.destination.amount** (Number) - The amount of tokens minted.
  - **result.contract** (Object) - Information about the ERC20 contract.
    - **result.contract.address** (String) - The contract address.
    - **result.contract.name** (String) - The name of the token.
    - **result.contract.symbol** (String) - The symbol of the token.
    - **result.contract.maxSupply** (Number) - The maximum supply of the token.
    - **result.contract.burnable** (Boolean) - Indicates if the token is burnable.
    - **result.contract.owner** (String) - The owner of the contract.
    - **result.contract.type** (String) - The type of the token (e.g., ERC_20).

#### Response Example
```json
{
    "success": true,
    "result": {
        "mints": [
            {
                "id": "273e6ecb-fb1b-44f0-a9ff-a19bbf92099a",
                "createdOn": "2024-09-23T09:34:21.973064048",
                "status": "PENDING",
                "destination": {
                    "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
                    "amount": 25
                }
            },
            {
                "id": "8a4a03ac-e1e8-4468-bdce-1e57e809d89f",
                "createdOn": "2024-09-23T09:34:21.977695915",
                "status": "PENDING",
                "destination": {
                    "address": "0xb811Fac088E8E80F56258a5f29D47d0FF1a37BD5",
                    "amount": 5
                }
            }
        ],
        "contract": {
            "address": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
            "name": "Venly Test Token",
            "symbol": "VTT",
            "maxSupply": 150,
            "burnable": true,
            "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9",
            "type": "ERC_20"
        }
    }
}
```
```

--------------------------------

### POST /api/v3/erc20/tokens/mints

Source: https://docs.venly.io/docs/token-api-getting-started

Mints and sends ERC20 tokens to specified wallet addresses. This endpoint allows for batch minting to multiple destinations.

```APIDOC
## POST /api/v3/erc20/tokens/mints

### Description
Mints and sends ERC20 tokens to specified wallet addresses. This endpoint allows for batch minting to multiple destinations.

### Method
POST

### Endpoint
/api/v3/erc20/tokens/mints

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **chain** (String) - Required - The blockchain of the token contract
- **contractAddress** (String) - Required - The token contract address
- **destinations** (Array of objects) - Required - The array includes all the wallet addresses and the number of ERC20 tokens to mint per wallet address
  - **destinations.address** (String) - Required - The wallet address to mint and send the ERC20 tokens to
  - **destinations.amount** (Number) - Required - The number of ERC20 tokens you want to mint and send

### Request Example
```json
{
    "chain": "MATIC",
    "contractAddress": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
    "destinations": [
        {
            "address": "0xb811Fac088E8E80F56258a5f29D47d0FF1a37BD5",
            "amount": "5"
        },
        {
            "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
            "amount": "25"
        }
    ]
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains the details of the minting operations.
  - **result.mints** (Array of objects) - A list of minting operations, each with an ID, creation date, status, and destination details.
    - **result.mints[].id** (String) - The unique identifier for the mint operation. This ID can be used to track the token mint request.
    - **result.mints[].createdOn** (String) - The timestamp when the mint operation was created.
    - **result.mints[].status** (String) - The current status of the mint operation (e.g., PENDING).
    - **result.mints[].destination** (Object) - Details about the destination of the minted tokens.
      - **result.mints[].destination.address** (String) - The wallet address where the tokens were sent.
      - **result.mints[].destination.amount** (Number) - The amount of tokens minted and sent.
  - **result.contract** (Object) - Details about the ERC20 token contract.
    - **result.contract.address** (String) - The address of the ERC20 token contract.
    - **result.contract.name** (String) - The name of the token.
    - **result.contract.symbol** (String) - The symbol of the token.
    - **result.contract.maxSupply** (Number) - The maximum supply of the token.
    - **result.contract.burnable** (Boolean) - Indicates if the token is burnable.
    - **result.contract.owner** (String) - The owner of the token contract.
    - **result.contract.type** (String) - The type of the token (e.g., ERC_20).

#### Response Example
```json
{
    "success": true,
    "result": {
        "mints": [
            {
                "id": "273e6ecb-fb1b-44f0-a9ff-a19bbf92099a",
                "createdOn": "2024-09-23T09:34:21.973064048",
                "status": "PENDING",
                "destination": {
                    "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
                    "amount": 25
                }
            },
            {
                "id": "8a4a03ac-e1e8-4468-bdce-1e57e809d89f",
                "createdOn": "2024-09-23T09:34:21.977695915",
                "status": "PENDING",
                "destination": {
                    "address": "0xb811Fac088E8E80F56258a5f29D47d0FF1a37BD5",
                    "amount": 5
                }
            }
        ],
        "contract": {
            "address": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
            "name": "Venly Test Token",
            "symbol": "VTT",
            "maxSupply": 150,
            "burnable": true,
            "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9",
            "type": "ERC_20"
        }
    }
}
```
```

--------------------------------

### Mint ERC20 Tokens

Source: https://docs.venly.io/docs/token-api-getting-started

Mints new ERC20 tokens for a deployed token contract and sends them to a specified destination wallet address.

```APIDOC
## POST /api/v3/erc20/tokens/mints

### Description
After deploying an ERC20 token contract, this endpoint allows you to mint new tokens. You need to provide the token contract address and the destination wallet address for the minted tokens.

### Method
POST

### Endpoint
/api/v3/erc20/tokens/mints

### Parameters
#### Request Body
- **contractAddress** (String) - Required - The address of the ERC20 token contract.
- **toAddress** (String) - Required - The wallet address that will receive the minted tokens.
- **amount** (String) - Required - The amount of tokens to mint.

### Request Example
```json
{
    "contractAddress": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
    "toAddress": "0xYourRecipientWalletAddress",
    "amount": "1000"
}
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains details about the minting transaction.
  - **transactionHash** (String) - The transaction hash of the token minting.
  - **status** (String) - The status of the minting transaction.

#### Response Example
```json
{
    "success": true,
    "result": {
        "transactionHash": "0xYourTransactionHashHere",
        "status": "PENDING"
    }
}
```
```

--------------------------------

### Contract Creation API

Source: https://docs.venly.io/docs/nft-api-getting-started

This endpoint allows you to deploy a new contract, which represents a collection for your NFTs. The contract will be created on a specified testnet chain.

```APIDOC
## POST /api/v3/erc1155/contracts/deployments

### Description
Deploys a new NFT contract, serving as a collection for NFTs. The deployment occurs on a testnet chain for sandbox environments.

### Method
POST

### Endpoint
/api/v3/erc1155/contracts/deployments

### Parameters

#### Request Body
- **name** (string) - Required - The name of the contract (NFT collection).
- **symbol** (string) - Required - The symbol for the contract.
- **chain** (string) - Required - The blockchain on which to deploy the contract (e.g., 'MATIC_TESTNET').
- **supply_type** (string) - Required - The type of supply for the NFTs (e.g., 'FIXED_SUPPLY', 'DYNAMIC_SUPPLY').
- **royalty_percentage** (number) - Optional - The royalty percentage for secondary sales.
- **royalty_recipient** (string) - Optional - The wallet address of the royalty recipient.

### Request Example
```json
{
  "name": "My Awesome Collection",
  "symbol": "MAC",
  "chain": "MATIC_TESTNET",
  "supply_type": "FIXED_SUPPLY",
  "royalty_percentage": 5,
  "royalty_recipient": "0x1234567890abcdef1234567890abcdef12345678"
}
```

### Response
#### Success Response (201 Created)
- **contract_id** (string) - The unique identifier for the deployed contract.
- **status** (string) - The status of the contract deployment (e.g., 'PENDING', 'DEPLOYED').

#### Response Example
```json
{
  "contract_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "PENDING"
}
```
```

--------------------------------

### Check Token-Type Status Request Example (HTTP)

Source: https://docs.venly.io/docs/nft-api-getting-started

This is an example of an HTTP GET request to check the status of a token-type creation. The `creationId` is obtained from the response of the create token-type endpoint.

```http
GET /api/v3/erc1155/token-types/creations/92ebfbb7-df9a-4228-9b57-6614315fc896
```

--------------------------------

### Full Wallet Creation Script in Unity

Source: https://docs.venly.io/docs/getting-started-with-unity

A complete Unity script demonstrating the initialization of the Venly API, definition of wallet creation parameters, and the asynchronous call to create a wallet. It includes success and error handling for the API response.

```csharp
void Start()
{
    //Initialize API (should only be done once)
    VenlyUnity.Initialize();
    
    // Define the CreateWalletRequest
    var createParams = new VyCreateWalletRequest()
        {
            Chain = eVyChain.Matic,
            Description = "My First Wallet", //A simple description
            Identifier = "demo_0", //Can be used to filter wallets
            Pincode = "1234", //Needed to perform certain actions on the wallet (e.g. transfer)
            WalletType = eVyWalletType.WhiteLabel //WhiteLabel is fine in most cases
        };
    
    // Calling the API (VenlyAPI>Wallet>CreateWallet)
    VenlyAPI.Wallet.CreateWallet(createParams)
        .OnComplete(result =>
        {
            if (result.Success)
            {
                var walletData = result.Data;
                Debug.Log($"You created your first wallet! (id={walletData.Id})");
            }
            else
            {
                //Hmmm, something went wrong
                Debug.LogException(result.Exception);
            }
        });
}
```

--------------------------------

### Install Web3-Onboard Core and Injected Wallets

Source: https://docs.venly.io/docs/web3onboard

Installs the core Web3-Onboard library and the module for handling injected browser wallets. This is typically the first step in integrating Web3-Onboard into a project.

```javascript
npm install @web3-onboard/core @web3-onboard/injected-wallets
```

--------------------------------

### Check Token-Type Creation Status (HTTP)

Source: https://docs.venly.io/v2.0/docs/nft-api-getting-started

This shows an example HTTP GET request to check the status of a token-type creation using its unique ID. The response indicates the creation status ('SUCCEEDED', 'PENDING', or 'FAILED').

```http
GET /api/v2/token-types/creations/45cf858a-cb0d-4e31-b6e1-b3bf4c65d014
```

--------------------------------

### User Management API

Source: https://docs.venly.io/docs/wallet-api-getting-started

Guides on creating users and managing their signing methods, which are essential for interacting with wallets.

```APIDOC
## Create User

### Description
Creates a new user within the Venly system.

### Method
POST

### Endpoint
`/api/v2/users`

### Parameters
#### Request Body
- **profileAttributes** (object) - Optional - Attributes for the user's profile.
  - **name** (string) - Optional - The user's name.

### Request Example
```json
{
  "profileAttributes": {
    "name": "John Doe"
  }
}
```

### Response
#### Success Response (201 Created)
- **userId** (string) - The unique identifier for the newly created user.
- **profileAttributes** (object) - The profile attributes of the created user.

#### Response Example
```json
{
  "userId": "user-12345",
  "profileAttributes": {
    "name": "John Doe"
  }
}
```
```

```APIDOC
## Create Signing Method for User

### Description
Creates a signing method (e.g., a PIN) for a user, which is required to access their wallet.

### Method
POST

### Endpoint
`/api/v2/users/{userId}/signing-methods`

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user for whom to create the signing method.

#### Request Body
- **type** (string) - Required - The type of signing method, e.g., `PIN`.
- **attributes** (object) - Required - Attributes specific to the signing method type.
  - **pin** (string) - Required - The PIN code for the user.

### Request Example
```json
{
  "type": "PIN",
  "attributes": {
    "pin": "123456"
  }
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The ID of the created signing method.
- **type** (string) - The type of the signing method.

#### Response Example
```json
{
  "id": "signing-method-abcde",
  "type": "PIN"
}
```
```

--------------------------------

### Request to Buy an Offer

Source: https://docs.venly.io/v2.0/docs/market-api-getting-started

Initiates the purchase of an offer on the Venly marketplace. Requires offer ID, user ID, wallet address, and amount. The response indicates the initial status, often 'QUEUED'.

```json
{
  "type": "PURCHASE",
  "offerId": "90f1cce7-ae3f-4d54-a11a-e10dccdd0cce",
  "userId": "6eb26b77-268d-4772-a788-21b09e099df3",
  "walletAddress": "0x722c4b8649d54ae2feb9697b178cb37c955d6b48",
  "amount": 1
}
```

--------------------------------

### Define Create Wallet Parameters

Source: https://docs.venly.io/docs/getting-started-with-unity

Defines the parameters required for creating a new wallet. This includes setting the blockchain chain, a description for the wallet, a unique identifier, a PIN code for security, and the wallet type.

```csharp
// Define the CreateWalletRequest
var createParams = new VyCreateWalletRequest()
    {
        Chain = eVyChain.Matic,
        Description = "My First Wallet", //A simple description
        Identifier = "demo_0", //Can be used to filter wallets
        Pincode = "1234", //Needed to perform certain actions on the wallet (e.g. transfer)
        WalletType = eVyWalletType.WhiteLabel //WhiteLabel is fine in most cases
    };
```

--------------------------------

### Check NFT Collection Deployment Status Request

Source: https://docs.venly.io/docs/nft-api-getting-started

This is an example of an HTTP GET request to check the deployment status of an NFT collection. The {deploymentId} in the URL path is a unique identifier obtained from the create contract/collection endpoint's response.

```http
GET /api/v3/erc1155/contracts/deployments/5ad5b26d-77d0-46ee-aa4d-569878b74b58
```

--------------------------------

### POST /websites/venly_io/offers

Source: https://docs.venly.io/v2.0/docs/market-api-getting-started

Creates a new sale offer for an NFT on the Venly IO platform. This endpoint allows sellers to specify NFT details, sale parameters, and pricing.

```APIDOC
## POST /websites/venly_io/offers

### Description
Creates a new sale offer for an NFT. This endpoint allows sellers to specify NFT details, sale parameters, and pricing, including minimum bid, buy-now price, and the actual offer price.

### Method
POST

### Endpoint
/websites/venly_io/offers

### Parameters
#### Request Body
- **nft** (Object) - Required - Includes the information of the NFT that is being put on sale
  - **tokenId** (String) - Required - The `tokenID` of the NFT
  - **address** (String) - Required - The `address` of the NFT
  - **chain** (String) - Required - The blockchain of the NFT
- **startDate** (String) - Required - The start date of your sale offer in ISO 8601 format
- **endDate** (String) - Required - The end date of your sale offer in ISO 8601 format
- **type** (String) - Required - The type of offer. Currently, only `SALE` is supported.
- **currency** (String) - Required - The currency in which you want to sell your offer. Currently, only **USDC** is supported.
- **sellerId** (String) - Required - The `ID` of the seller
- **sellerAddress** (String) - Required - The wallet address of the seller and where the NFT is currently held
- **visibility** (String) - Required - Indicator to put the offer as public or private
- **minimumBid** (Integer) - Optional - The minimum bid allowed for the offer
- **buyNowPrice** (Integer) - Optional - The price of your offer if someone wants to instantly buy it without bidding
- **price** (Integer) - Optional - The actual price of your offer

### Request Example
```json
{
  "nft": {
    "tokenId": "6",
    "address": "0xb00e62813579d22f143dc194a6377433ad1b2032",
    "chain": "MATIC"
  },
  "startDate": "2023-10-24T10:44:03.331Z",
  "endDate": "2023-10-27T10:44:03.331Z",
  "type": "SALE",
  "currency": "USDC",
  "sellerId": "6eb26b77-268d-4772-a788-21b09e099df3",
  "sellerAddress": "0x722c4b8649d54ae2feb9697b178cb37c955d6b48",
  "visibility": "PUBLIC",
  "minimumBid": 1,
  "buyNowPrice": 1.5,
  "price": 1
}
```

### Response
#### Success Response (200)
- **offerId** (String) - The unique identifier for the created offer.
- **message** (String) - A confirmation message indicating the offer was created successfully.

#### Response Example
```json
{
  "offerId": "offer_12345abc",
  "message": "Sale offer created successfully."
}
```
```

--------------------------------

### GET /api/v3/erc20/tokens/mints/{mintId}

Source: https://docs.venly.io/v3.0/docs/token-api-getting-started

Retrieves the status of a specific ERC20 token mint request using its unique mint ID.

```APIDOC
## GET /api/v3/erc20/tokens/mints/{mintId}

### Description
Checks the status of a token mint request using the provided mint ID.

### Method
GET

### Endpoint
/api/v3/erc20/tokens/mints/{mintId}

### Parameters
#### Path Parameters
- **mintId** (String) - Required - The unique identifier for the mint request.

### Request Example
```
GET /api/v3/erc20/tokens/mints/273e6ecb-fb1b-44f0-a9ff-a19bbf92099a
```

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the request was successful.
- **result** (Object) - Contains details about the mint status.
  - **result.id** (String) - The mint ID.
  - **result.createdOn** (String) - The timestamp when the mint request was created.
  - **result.status** (String) - The current status of the mint request (SUCCEEDED, PENDING, or FAILED).
  - **result.transactionHash** (String) - The transaction hash on the blockchain if the mint was successful.
  - **result.destination** (Object) - Details about the destination.
    - **result.destination.address** (String) - The wallet address.
    - **result.destination.amount** (Number) - The amount of tokens minted.
  - **result.contract** (Object) - Information about the ERC20 contract.
    - **result.contract.address** (String) - The contract address.
    - **result.contract.name** (String) - The name of the token.
    - **result.contract.symbol** (String) - The symbol of the token.
    - **result.contract.maxSupply** (Number) - The maximum supply of the token.
    - **result.contract.burnable** (Boolean) - Indicates if the token is burnable.
    - **result.contract.owner** (String) - The owner of the contract.
    - **result.contract.type** (String) - The type of the token (e.g., ERC_20).

#### Response Example
```json
{
    "success": true,
    "result": {
        "id": "273e6ecb-fb1b-44f0-a9ff-a19bbf92099a",
        "createdOn": "2024-09-23T09:34:21.973064",
        "status": "SUCCEEDED",
        "transactionHash": "0x2196af03642bf02a6ba6f416098ee50d03fba9343edb5938eaa7969e13bef2c2",
        "destination": {
            "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
            "amount": 25
        },
        "contract": {
            "address": "0x44b1dc2b16e315e846e9f00c11282d19265be983",
            "name": "Venly Test Token",
            "symbol": "VTT",
            "maxSupply": 150,
            "burnable": true,
            "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9",
            "type": "ERC_20"
        }
    }
}
```
```
Tokens:
Raw