LogoLogo
  • Horizon Network
    • What is Horizon Network?
    • API Document
      • Horizon Network API
      • Quick Start
      • API Reference
        • Assets
        • Collections
        • Orders
        • Offers
        • Events
        • Statistics
        • Categories
        • Chains
        • Request an API key
    • SDKs Document
      • SDKs overview
      • NODE SDK
        • Installation
        • Initialization
        • Basic Example
          • Assets Management
          • Marketplace
        • Reference
          • Assets
          • Collections
          • Offers
          • Orders
          • Categories
          • Events
          • Statistics
          • Blockchain and Layer 2
      • JAVASCRIPT SDK
        • Overview
        • Installation
        • Quickstart
        • Reference
    • Launching NFT Collection
      • Launch A Collection
        • Overview
        • Part 1: Register as a user
        • Part 2: Deploy a smart contract
        • Part 3: Set creator earnings
        • Horizon Example Repository
      • Creating Your NFT Smart Contract
        • Overview
        • Getting Started
        • Setting a basic project
        • Minting from your new contract
        • Add your own NFT contract to Horizon Network
    • Horizon Network's Layer 2 Solution
      • Why Horizon Network?
      • Horizon Network's layer 2 Solutions
      • Basic Concepts
  • Horizon Land Metaverse
    • Feature
      • LAND in the metaverse
      • NFT Avatar
      • Horizon Center
      • Game Center
      • Shopping Center
      • Music Center
      • Play to Earn
      • Social Activities
      • Finance Center
      • Marketplace
      • Experience Mode
      • Zon Token
    • Stake Holder
      • Players
      • Creators
      • Land Owners
      • Partners
      • Investors
    • Economy
      • Revenue Stream
  • Technology
    • Blockchain
    • Product
    • System
    • Wallet
    • Security
    • Token
  • Tokenomic
  • Investor & Partner
  • Roadmap
  • Contact
  • Conclusion
  • Recommendation
  • FAQs
    • Policy
    • Terms of Use
Powered by GitBook
On this page
  1. Horizon Network
  2. API Document
  3. API Reference

Collections

PreviousAssetsNextOrders

Last updated 2 years ago

Get a list of collections

Get detail of a collection

Create a collection

Update a collection

Get list of collections

get

Get list of collections

Query parameters
chain_idstringOptional

Chain ID

category_idstringOptional

Category ID

owner_addressstringOptional

Owner address

statusstring · enumOptional

Status of these asset

Possible values:
limitintegerOptional

Limit

pagestringOptional

Current page number

order_bystring · enumOptional

Property to sort by

Possible values:
directionstring · enumOptional

Direction to sort

Possible values:
Responses
get
GET /v1/collections HTTP/1.1
Host: api.sandbox.horizonland.app
Accept: */*

{
  "cursor": "text",
  "remaining": 1,
  "result": [
    {
      "contract_address": "text",
      "owner": "text",
      "total_supply": 1,
      "category": {
        "category_id": "text",
        "category_name": "text"
      },
      "name": "text",
      "slug": "text",
      "description": {},
      "image_url": "text",
      "discord_url": "text",
      "telegram_url": "text",
      "external_url": "text",
      "twitter_username": "text",
      "instagram_username": "text",
      "fees": [
        {
          "address": "text",
          "basis_points": 1,
          "type": "text"
        }
      ],
      "chain": {
        "id": "text",
        "name": "text",
        "symbol": "text"
      },
      "assets": {
        "cursor": "text",
        "remaining": 1,
        "result": [
          {
            "collection": {
              "image_url": "text",
              "name": "text",
              "contract_address": "text"
            },
            "created_at": "text",
            "description": "text",
            "fees": [
              {
                "address": "text",
                "basis_points": 1,
                "type": "text"
              }
            ],
            "id": "text",
            "image_url": "text",
            "animation_url": "text",
            "external_link": "text",
            "metadata": {},
            "name": "text",
            "listing": {
              "closing_date": "text",
              "fees": [
                {
                  "address": "text",
                  "basis_points": 1,
                  "type": "text"
                }
              ],
              "accept_price": 1,
              "start_price": 1,
              "current_price": 1,
              "name": "text",
              "token_address": "text",
              "token_id": "text",
              "chain": {
                "id": "text",
                "name": "text",
                "symbol": "text"
              }
            },
            "status": "text",
            "token_address": "text",
            "token_id": "text",
            "chain": {
              "id": "text",
              "name": "text",
              "symbol": "text"
            },
            "updated_at": "text",
            "owner": "text"
          }
        ]
      }
    }
  ]
}

Get details of a collection at the given address

get

Get details of a collection at the given address

Path parameters
addressstringRequired

Collection contract address

Query parameters
include_assetsbooleanOptional

Include assets in response

Responses
get
GET /v1/collections/{address} HTTP/1.1
Host: api.sandbox.horizonland.app
Accept: */*

{
  "contract_address": "text",
  "owner": "text",
  "total_supply": 1,
  "category": {
    "category_id": "text",
    "category_name": "text"
  },
  "name": "text",
  "slug": "text",
  "description": {},
  "image_url": "text",
  "discord_url": "text",
  "telegram_url": "text",
  "external_url": "text",
  "twitter_username": "text",
  "instagram_username": "text",
  "fees": [
    {
      "address": "text",
      "basis_points": 1,
      "type": "text"
    }
  ],
  "chain": {
    "id": "text",
    "name": "text",
    "symbol": "text"
  },
  "assets": {
    "cursor": "text",
    "remaining": 1,
    "result": [
      {
        "collection": {
          "image_url": "text",
          "name": "text",
          "contract_address": "text"
        },
        "created_at": "text",
        "description": "text",
        "fees": [
          {
            "address": "text",
            "basis_points": 1,
            "type": "text"
          }
        ],
        "id": "text",
        "image_url": "text",
        "animation_url": "text",
        "external_link": "text",
        "metadata": {},
        "name": "text",
        "listing": {
          "closing_date": "text",
          "fees": [
            {
              "address": "text",
              "basis_points": 1,
              "type": "text"
            }
          ],
          "accept_price": 1,
          "start_price": 1,
          "current_price": 1,
          "name": "text",
          "token_address": "text",
          "token_id": "text",
          "chain": {
            "id": "text",
            "name": "text",
            "symbol": "text"
          }
        },
        "status": "text",
        "token_address": "text",
        "token_id": "text",
        "chain": {
          "id": "text",
          "name": "text",
          "symbol": "text"
        },
        "updated_at": "text",
        "owner": "text"
      }
    ]
  }
}
  • Get a list of collections
  • GETGet list of collections
  • Get detail of a collection
  • GETGet details of a collection at the given address
  • Create a collection
  • POSTCreate a collection
  • Update a collection
  • PUTUpdate collection

Create a collection

post

Create a collection

Body
contract_addressstringOptional

Contract address of the collection

total_supplynumberOptional

Total supply of the collection

namestringOptional

Name of the collection

descriptionobjectOptional

Desction of the collection

image_urlstringOptional

Image URL of the collection

discord_urlstringOptional

Discord URL of the collection

telegram_urlstringOptional

Telegram URL of the collection

external_urlstringOptional

External URL of the collection

twitter_usernamestringOptional

Twitter username of the collection

instagram_usernamestringOptional

Instagram username of the collection

chain_idstringOptional

Chain ID of all assets of this collection

category_idstringOptional

Category ID of the collection

Responses
post
POST /v1/collections HTTP/1.1
Host: api.sandbox.horizonland.app
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "contract_address": "text",
  "total_supply": 1,
  "name": "text",
  "description": {},
  "image_url": "text",
  "discord_url": "text",
  "telegram_url": "text",
  "external_url": "text",
  "twitter_username": "text",
  "instagram_username": "text",
  "fees": [
    {
      "address": "text",
      "basis_points": 1,
      "type": "text"
    }
  ],
  "chain_id": "text",
  "category_id": "text"
}
{
  "contract_address": "text",
  "owner": "text",
  "total_supply": 1,
  "category": {
    "category_id": "text",
    "category_name": "text"
  },
  "name": "text",
  "slug": "text",
  "description": {},
  "image_url": "text",
  "discord_url": "text",
  "telegram_url": "text",
  "external_url": "text",
  "twitter_username": "text",
  "instagram_username": "text",
  "fees": [
    {
      "address": "text",
      "basis_points": 1,
      "type": "text"
    }
  ],
  "chain": {
    "id": "text",
    "name": "text",
    "symbol": "text"
  },
  "assets": {
    "cursor": "text",
    "remaining": 1,
    "result": [
      {
        "collection": {
          "image_url": "text",
          "name": "text",
          "contract_address": "text"
        },
        "created_at": "text",
        "description": "text",
        "fees": [
          {
            "address": "text",
            "basis_points": 1,
            "type": "text"
          }
        ],
        "id": "text",
        "image_url": "text",
        "animation_url": "text",
        "external_link": "text",
        "metadata": {},
        "name": "text",
        "listing": {
          "closing_date": "text",
          "fees": [
            {
              "address": "text",
              "basis_points": 1,
              "type": "text"
            }
          ],
          "accept_price": 1,
          "start_price": 1,
          "current_price": 1,
          "name": "text",
          "token_address": "text",
          "token_id": "text",
          "chain": {
            "id": "text",
            "name": "text",
            "symbol": "text"
          }
        },
        "status": "text",
        "token_address": "text",
        "token_id": "text",
        "chain": {
          "id": "text",
          "name": "text",
          "symbol": "text"
        },
        "updated_at": "text",
        "owner": "text"
      }
    ]
  }
}

Update collection

put

Update collection

Path parameters
addressstringRequired

Collection contract address

Header parameters
access tokenstringRequired

API Key

Body
namestringOptional

Name of the collection

descriptionobjectOptional

Desction of the collection

image_urlstringOptional

Image URL of the collection

discord_urlstringOptional

Discord URL of the collection

telegram_urlstringOptional

Telegram URL of the collection

external_urlstringOptional

External URL of the collection

twitter_usernamestringOptional

Twitter username of the collection

instagram_usernamestringOptional

Instagram username of the collection

Responses
put
PUT /v1/collections/{address} HTTP/1.1
Host: api.sandbox.horizonland.app
access token: text
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "name": "text",
  "description": {},
  "image_url": "text",
  "discord_url": "text",
  "telegram_url": "text",
  "external_url": "text",
  "twitter_username": "text",
  "instagram_username": "text"
}
{
  "contract_address": "text",
  "owner": "text",
  "total_supply": 1,
  "category": {
    "category_id": "text",
    "category_name": "text"
  },
  "name": "text",
  "slug": "text",
  "description": {},
  "image_url": "text",
  "discord_url": "text",
  "telegram_url": "text",
  "external_url": "text",
  "twitter_username": "text",
  "instagram_username": "text",
  "fees": [
    {
      "address": "text",
      "basis_points": 1,
      "type": "text"
    }
  ],
  "chain": {
    "id": "text",
    "name": "text",
    "symbol": "text"
  },
  "assets": {
    "cursor": "text",
    "remaining": 1,
    "result": [
      {
        "collection": {
          "image_url": "text",
          "name": "text",
          "contract_address": "text"
        },
        "created_at": "text",
        "description": "text",
        "fees": [
          {
            "address": "text",
            "basis_points": 1,
            "type": "text"
          }
        ],
        "id": "text",
        "image_url": "text",
        "animation_url": "text",
        "external_link": "text",
        "metadata": {},
        "name": "text",
        "listing": {
          "closing_date": "text",
          "fees": [
            {
              "address": "text",
              "basis_points": 1,
              "type": "text"
            }
          ],
          "accept_price": 1,
          "start_price": 1,
          "current_price": 1,
          "name": "text",
          "token_address": "text",
          "token_id": "text",
          "chain": {
            "id": "text",
            "name": "text",
            "symbol": "text"
          }
        },
        "status": "text",
        "token_address": "text",
        "token_id": "text",
        "chain": {
          "id": "text",
          "name": "text",
          "symbol": "text"
        },
        "updated_at": "text",
        "owner": "text"
      }
    ]
  }
}