Skip to main content

Get User Offers

POST 
/private/NftUserOffers

Get NFT user offers. Gets the offers placed by the requesting user or received to owned NFTs.

Request​

Body

required
    chain string[]nullable

    Optional chain id filter

    collection string[]nullable

    Optional collection id filter

    count uint32nullable

    Offers to return per request

    end_time uint32nullable

    unix time (in seconds) defining the latest offer time. Set to 0 to requests latest as possible.

    exclude_quotes booleannullable

    Exclude offers linked to a quote. That excludes any offer initiated by Market Maker.

    nft_id stringnullable

    Optional nft id filter

    nonce int64required

    Nonce used in construction of API-Sign header

    otp stringnullable
    pos uint32required

    Paging offset

    scope stringrequired

    Possible values: [placed, received]

    Offer scope, Placed or Received

    sort stringrequired

    Possible values: [desc, asc]

    Sort method

    start_time uint32nullable

    unix time (in seconds) defining the earliest offer time

    status stringnullable

    Possible values: [open, closed, expired]

    Optional offer status filter

Responses​

Response

Schema
    error string[]required
    result objectnullable
    count int64required

    Total count of user offers

    offers object[]required

    Array of user offers

  • Array [
    • amount objectrequired

    Offer amount

    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

    expire_time uint32required

    unix time (in seconds) defining the offer expiry time

    id stringrequired

    Offer id

    item objectrequired

    NFT details

    blockchain objectrequired
    asset stringrequired
    id stringrequired
    collection_id stringrequired
    collection_name stringrequired
    creators string[]required
    nft_id stringrequired
    nft_image objectnullable

    Main image for this NFT This is provided for easier access, but it may be retrieved from nft_media too.

    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.

    nft_media object[]required

    All media for this NFT

  • 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.

  • ]
    • nft_name stringrequired
    nft_thumbnail_url stringrequired
    quote_id stringnullable

    Optional quote id

    ref_bucket_id stringrequired
    social_id stringrequired

    Social id of the offers's creator user

    status stringrequired

    Possible values: [open, closed, expired]

    Offer status

    status_detail stringrequired

    Offer status detail

    time uint32required

    unix time (in seconds) defining the offer creation time

  • ]
Loading...