NFT Contracts

Explore NFT collections within the Starknet ecosystem effortlessly.

Contract Model

Our NFT contract framework is designed to simplify your interaction with contracts in the ArkProject ecosystem. Each contract is identified by a unique address, serving as its digital signature. The type of the contract provides insight into its function or role.

Key details like the name and symbol make each contract easily identifiable, reflecting its essence or theme. The optional image attribute helps visualize the contract, making it more recognizable.

Properties

  • Name
    contract_address
    Type
    string
    Description

    Unique identifier for the contract.

  • Name
    contract_type
    Type
    string
    Description

    The type of contract.

  • Name
    name
    Type
    string
    Description

    The name of the contract.

  • Name
    symbol
    Type
    string
    Description

    The symbol for the contract.

  • Name
    image
    Type
    string
    Description

    The image representing the contract. It can be nullable.


GET/v1/contracts

List all NFT contracts

This endpoint allows you to retrieve all Starknet NFT contracts.

Query string parameters

  • Name
    cursor
    Type
    string
    Description

    The cursor to get the next page. Retrieved from previous request that may be paginated.

  • Name
    limit
    Type
    number
    Description

    The limit on the number of items returned per request, defaulting to 100, with a 1MB data cap. (Refer to the pagination section below for more details.)

Request

GET
/v1/contracts
curl https://api.arkproject.dev/v1/contracts \
  -H "x-api-key: <INSERT_API_KEY_HERE>"

Response

{
  "cursor": null,
  "result": [
      {
          "contract_address": "0x076503062d78f4481be03c9145022d6a4a71ec0719aa07756f79a2384dc7ef16",
          "contract_type": "ERC721",
          "name": "Starknet Quest",
          "symbol": "SKQ",
          "image": "https://starknet.quest/starkfighter/level1.webp"
      },
      {
          "contract_address": "0x060582df2cd4ad2c988b11fdede5c43f56a432e895df255ccd1af129160044b8",
          "contract_type": "ERC721",
          "name": "StarkVerse Gallery",
          "symbol": "SVG",
          "image": "https://starkverse.art/gallery_genesis.png"
      },
      {...},
      {...}
  }

GET/v1/contracts/{contract_address}

Retrieve an NFT Contract

This endpoint allows you to retrieve an nft contract by providing its contract address. Refer to the list at the top of this page to see which properties are included with collection objects.

Path parameters

  • Name
    contract_address
    Type
    string
    Description

    Hexadecimal address of the contract.

Request

GET
/v1/contracts/{contract_address}
curl https://api.arkproject.dev/v1/contracts/{contract_address} \
  -H "x-api-key: <INSERT_API_KEY_HERE>"

Response

{
  "cursor": null,
  "result": {
      "contract_address": "0x1111",
      "symbol": "EVE",
      "name": "Everai",
      "image": null
  }
}