Skip to main content

Get Collection

GET 
/public/NftCollection

Returns a NFT Collection object by its identifier where identifier is a kraken internal identifier

Request​

Query Parameters

    collection_id stringrequired
    currency string

Responses​

Response

Schema
    error string[]required
    result objectnullable
    collection objectrequired
    blockchain_data object[]required

    Blockchain data of the collection

  • Array [
    • address stringrequired
    blockchain objectrequired
    asset stringrequired
    id stringrequired

    Possible values: [Ethereum, Solana, Polygon]

    symbol stringnullable
  • ]
    • creator_fee object

    Creator's fee

    oneOf

    string

    creator_fee_enforced booleannullable

    Flag indicating whether the creator fee is enforced or optional.

    creators object[]required

    creator of collection

  • Array [
    • blockchain_data object[]required

    Blockchain addresses associated with the Creator.

  • Array [
    • oneOf
    address stringrequired
    blockchain stringrequired

    Possible values: [Ethereum]

  • ]
    • date_added int64required

    Date when creator was added to the DB

    description stringrequired

    Description of the Creator.

    id stringrequired

    Server side generated ID of the Creator.

    image objectnullable

    Main image

    kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

    media object[]required

    All media for this creator.

  • Array [
    • kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

  • ]
    • name stringrequired

    Name of the Creator.

    social_media_links objectrequired

    Social media links

    property name* string
    tags string[]required

    Tags assigned to this Creator.

    top_banner objectnullable

    Top-banner image

    kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

    username stringnullable

    Username of the Creator.

    verified booleanrequired

    Verified by Kraken to have accurate data.

  • ]
    • date_added int64required

    a date when collection was added to the DB

    description stringnullable

    collection description

    floor_price objectnullable

    Floor price.

    fiat objectnullable

    Floor price in fiat currency, specified by a user.

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    native objectnullable

    Floor price in native currency of a blockchain that this collection belongs to.

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    original objectrequired

    Floor price in original asset, without applying any exchange rates.

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    id stringrequired

    kraken internal collection identifier

    image objectnullable

    Main image

    kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

    market_cap objectnullable

    Total market cap.

    fiat objectnullable

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    native objectrequired

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    media object[]required

    All media for this collection.

  • Array [
    • kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

  • ]
    • name stringrequired

    collection name

    seven_day_volume objectnullable

    Seven day volume of sales.

    fiat objectnullable

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    native objectrequired

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    social_media_links objectrequired

    Social media links

    property name* string
    tags string[]required

    Tags assigned to this Collection.

    top_banner objectnullable

    Top-banner image

    kind stringrequired

    Possible values: [Main, Image, Animation, Video, TopBanner, Other]

    Role of this media relative to the catalog object.

    media objectnullable

    Exact copy of the original media, stored in a Kraken server.

    DO NOT TRUST THIS DATA TO BE SAFE.

    Danger: this contains arbitrary content from the internet and may be malicious. This should never be embedded directly inside a webpage. Proper care should be given if linking to this media (e.g. use rel="noopener").

    Despite these risks, the raw media is still exposed as it's the true copy of the blockchain media as retrieved by Kraken. Viewing it may help if processing introduced defects to the media.

    The value depends on MediaProcessingState: - Wait or Source: None - Process or Ready: Some

    media_type stringnullable

    Media type: image/png, image/jpeg, etc.

    size uint64nullable

    Full size of the content in bytes.

    Note that the actual transfer size may be smaller if compression is applied.

    url stringrequired

    URL for the content of this media.

    This is always served as HTTPS, either from the Kraken media server directly or from a Cloudflare Images subdomain.

    total_items uint64required

    number of items in the collection

    total_owners uint64required

    number of owners

    total_volume objectnullable

    Total volume of sales.

    fiat objectnullable

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    native objectrequired

    AssetAmount contains asset_id and amount bound in one struct

    amount object required

    An amount, either as a string, and integer, or a decimal value

    oneOf

    string

    asset_alt_name stringrequired

    alt_name is handy when interacting with Kraken API

    asset_name stringrequired

    user friendly asset name for display purpose

    traits objectrequired

    Trait in the collection (i.e. Eyes, Stamina, ...).

    property name* object
    property name* uint64
    verified booleanrequired

    The collection was verified by Kraken.

Loading...