Crossmint

Description

Plugin for minting NFTs.

Details

Added6 months ago

Votes0

Total Installations0

Categorycrypto

Websitecrossmint.com

https://www.crossmint.com/.well-known/ai-plugin.json

{
    "schema_version": "v1",
    "name_for_human": "Crossmint",
    "name_for_model": "crossmint",
    "description_for_human": "Plugin for minting NFTs.",
    "description_for_model": "Plugin for minting NFTs. You can mint and edit NFTs in different blockchains",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "https://crossmint.com/openapi.yaml",
        "is_user_authenticated": false
    },
    "logo_url": "https://www.crossmint.com/assets/crossmint/logo.png",
    "contact_email": "support@crossmint.io",
    "legal_info_url": "https://www.crossmint.com/legal/terms-of-service"
}

https://crossmint.com/openapi.yaml

openapi: 3.0.1
servers:
  - url: "https://{env}.crossmint.com/api"
    variables:
      env:
        description: "Select between production (www) and testing (staging) environments"
        enum:
          - "www"
          - "staging"
        default: "staging"
security:
  - clientSecret: []
    projectId: []
info:
  description: >-
    N/A
  version: 1.0.0
  title: NFT Minting APIs
  contact:
    name: Crossmint NFT Minting APIs
    url: "https://crossmint.com"
    email: support@crossmint.com
tags:
  - name: metadata
    description: Find out about the data sets
  - name: search
    description: Search a data set
paths:
  /2022-06-09/collections/{collectionId}/nfts: # Mint NFT
    post:
      responses:
        "200":
          description: "Success."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MintResponse"
              examples:
                SolanaPending:
                  description: "Solana pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "solana"
                EVMPending:
                  description: "EVM pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "ethereum"
                      contractAddress: "0x123456789"
                SolanaExisting:
                  description: "Solana existing"
                  value:
                    id: "example-sol"
                    metadata:
                      name: "My first Mint API NFT"
                      symbol: ""
                      description: "My NFT created via the mint API!"
                      seller_fee_basis_points: 0
                      image: "https://nftstorage.link/ipfs/bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      attributes: []
                      properties:
                        files: []
                        category: "image"
                        creators: []
                    onChain:
                      status: "success"
                      mintHash: "9zb4yNune7rWko38utKVW3mwmXjR3jyVD8vuQZ6fufiG"
                      owner: "5WpDyJ2fUnh7dHG2HRive2S8bS57WYodRX1wPKa1QRYZ"
                      chain: "solana"
                EVMExisting:
                  description: "EVM existing"
                  value:
                    id: "example-evm"
                    metadata:
                      name: "My first Mint API NFT"
                      image: "ipfs://bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      description: "My NFT created via the mint API!"
                    onChain:
                      status: "success"
                      tokenId: "8"
                      owner: "0x81D9925146d6e13D6E52544Cfcff4907376c6c6d"
                      txId: "0xc4dcb052f5ab1f9885128dd3d58746c71aa10779a14d10742f820e769edfcbf0"
                      contractAddress: "0xc4F90B864F90D52dc863b3932BAD2F1e284e459A"
                      chain: "polygon"

        "400":
          description: "Invalid arguments, please make sure you're following the api specification."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: "Forbidden error, please ensure the credentials are correct."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: "Please try again in a few minutes. If the issue still persists, please contact Crossmint support."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      tags:
        - Mint
      summary: Mint an NFT
      description: >-
        Mint your NFTs and deliver them either to a web3 wallet or to a web2 email address seamlessly with our API.
      operationId: mint-nft
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'),
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipient:
                  type: string
                  default: "email:replaceme@youruser.com:solana"
                  description: "Recipient address in the format of `<chain>:<address>` or <br> `email:<email_address>:<chain>`.\nSee https://docs.crossmint.com/docs/recipients for more info."
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  oneOf:
                    - title: "Metadata object"
                      description: "See https://docs.crossmint.com/docs/metadata for more info."
                      type: object
                      required:
                        - name
                        - image
                        - description
                      properties:
                        name:
                          type: string
                          description: "The name of your NFT (Max length: 32)"
                          default: "My first Mint API NFT"
                          maxLength: 32
                        image:
                          type: string
                          description: "Direct link to your NFT image"
                          default: "https://www.crossmint.com/assets/crossmint/logo.png"
                        description:
                          type: string
                          description: "A quick and brief description of your NFT (Max length: 64)"
                          default: "My NFT created via the mint API!"
                          maxLength: 64
                        animation_url:
                          type: string
                          description: "(Optional) [Polygon only] <br> The Mint API natively supports rich metadata within ERC 721 and ERC 1155, including audio, video and/or HTML. <br> Populate the animation_url field as per the OpenSea metadata spec: <br> https://docs.opensea.io/docs/metadata-standards#metadata-structure"
                        attributes:
                          type: array
                          description: "(Optional) Add attributes to your NFT"
                          items:
                            type: object
                            required:
                              - trait_type
                              - value
                            properties:
                              display_type:
                                type: string
                                description: "Display name of your attribute"
                                default: ""
                                enum:
                                  - boost_number
                                  - boost_percentage
                                  - number
                              trait_type:
                                type: string
                                description: "The name of the trait"
                              value:
                                type: string
                                description: "The value of the trait"
                    - title: "Metadata url"
                      description: "Enter a url to a json file containing the metadata contents"
                      type: string
              required:
                - recipient
                - metadata
    get:
      responses:
        "200":
          description: "Success."
        "400":
          description: "Bad Request"
        "404":
          description: "Returned if the collection has no NFTs"
      tags:
        - Mint
      summary: Mint Status List
      description: >-
        Get a list of status and associated information for all mint operations in a given collection.
      operationId: mint-status-list
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
        - name: page
          in: query
          description: >-
            The page number you want to query, starting at 1
          required: true
          example: 1
          schema:
            type: number
        - name: perPage
          in: query
          description: >-
            How many items you want to be returned in the page.
          schema:
            type: number
            default: 20
  /v1-alpha1/minting/collections/{collectionId}/nfts: # Mint NFT (alpha)
    post:
      responses:
        "200":
          description: "Success."
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  onchain:
                    type: object
                    properties:
                      status:
                        type: string
                      chain:
                        type: string
                    required:
                      - status
                      - chain
              examples:
                SolanaPending:
                  description: "Solana pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "solana"
        "400":
          description: "Invalid arguments, please make sure you're following the api specification."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: "Forbidden error, please ensure the credentials are correct."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: "Please try again in a few minutes. If the issue still persists, please contact Crossmint support."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      tags:
        - Mint
      summary: Mint an NFT - Compressed
      description: >-
        This will mint your NFT with compression on Solana.
      operationId: mint-nft-alpha
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipient:
                  type: string
                  default: "email:replaceme@youruser.com:solana"
                  description: "Recipient address in the format of `<chain>:<address>` or <br> `email:<email_address>:<chain>`.\nSee https://docs.crossmint.com/docs/recipients for more info."
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  oneOf:
                    - title: "Metadata object"
                      description: "See https://docs.crossmint.com/docs/metadata for more info."
                      type: object
                      required:
                        - name
                        - image
                        - description
                      properties:
                        name:
                          type: string
                          description: "The name of your NFT (Max length: 32)"
                          default: "My first Mint API NFT"
                          maxLength: 32
                        image:
                          type: string
                          description: "Direct link to your NFT image"
                          default: "https://www.crossmint.com/assets/crossmint/logo.png"
                        description:
                          type: string
                          description: "A quick and brief description of your NFT (Max length: 64)"
                          default: "My NFT created via the mint API!"
                          maxLength: 64
                        animation_url:
                          type: string
                          description: "(Optional) [Polygon only] <br> The Mint API natively supports rich metadata within ERC 721 and ERC 1155, including audio, video and/or HTML. <br> Populate the animation_url field as per the OpenSea metadata spec: <br> https://docs.opensea.io/docs/metadata-standards#metadata-structure"
                        attributes:
                          type: array
                          description: "(Optional) Add attributes to your NFT"
                          items:
                            type: object
                            required:
                              - trait_type
                              - value
                            properties:
                              display_type:
                                type: string
                                description: "Display name of your attribute"
                                default: ""
                                enum:
                                  - boost_number
                                  - boost_percentage
                                  - number
                              trait_type:
                                type: string
                                description: "The name of the trait"
                              value:
                                type: string
                                description: "The value of the trait"
                    - title: "Metadata url"
                      description: "Enter a url to a json file containing the metadata contents"
                      type: string
              required:
                - recipient
                - metadata
  /2022-06-09/collections/{collectionId}/nfts/{nftName}: # Mint an NFT (Idempotent)
    put:
      responses:
        "200":
          description: "Success."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MintResponse"
              examples:
                SolanaPending:
                  description: "Solana pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "solana"
                EVMPending:
                  description: "EVM pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "ethereum"
                      contractAddress: "0x123456789"
                SolanaExisting:
                  description: "Solana existing"
                  value:
                    id: "example-sol"
                    metadata:
                      name: "My first Mint API NFT"
                      symbol: ""
                      description: "My NFT created via the mint API!"
                      seller_fee_basis_points: 0
                      image: "https://nftstorage.link/ipfs/bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      attributes: []
                      properties:
                        files: []
                        category: "image"
                        creators: []
                    onChain:
                      status: "success"
                      mintHash: "9zb4yNune7rWko38utKVW3mwmXjR3jyVD8vuQZ6fufiG"
                      owner: "5WpDyJ2fUnh7dHG2HRive2S8bS57WYodRX1wPKa1QRYZ"
                      chain: "solana"
                EVMExisting:
                  description: "EVM existing"
                  value:
                    id: "example-evm"
                    metadata:
                      name: "My first Mint API NFT"
                      image: "ipfs://bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      description: "My NFT created via the mint API!"
                    onChain:
                      status: "success"
                      tokenId: "8"
                      owner: "0x81D9925146d6e13D6E52544Cfcff4907376c6c6d"
                      txId: "0xc4dcb052f5ab1f9885128dd3d58746c71aa10779a14d10742f820e769edfcbf0"
                      contractAddress: "0xc4F90B864F90D52dc863b3932BAD2F1e284e459A"
                      chain: "polygon"

        "400":
          description: "Invalid arguments, please make sure you're following the api specification."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: "Forbidden error, please ensure the credentials are correct."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: "Please try again in a few minutes. If the issue still persists, please contact Crossmint support."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      tags:
        - Mint
      summary: Mint an NFT (Idempotent)
      description: >-
        This pathway allows you to mint NFTs and 
        guarantee idempotency
      operationId: mint-nft-idempotent
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
        - name: nftName
          in: path
          description: "Name of the NFT, which is used as an idempotency key"
          required: true
          example: "default"
          schema:
            type: string
            default: "my-idempotent-nft-name"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipient:
                  type: string
                  default: "email:replaceme@youruser.com:solana"
                  description: "Recipient address in the format of `<chain>:<address>` or <br> `email:<email_address>:<chain>`.\nSee https://docs.crossmint.com/docs/recipients for more info."
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  oneOf:
                    - title: "Metadata object"
                      description: "See https://docs.crossmint.com/docs/metadata for more info."
                      type: object
                      required:
                        - name
                        - image
                        - description
                      properties:
                        name:
                          type: string
                          description: "The name of your NFT (Max length: 32)"
                          default: "My first Mint API NFT"
                          maxLength: 32
                        image:
                          type: string
                          description: "Direct link to your NFT image"
                          default: "https://www.crossmint.com/assets/crossmint/logo.png"
                        description:
                          type: string
                          description: "A quick and brief description of your NFT (Max length: 64)"
                          default: "My NFT created via the mint API!"
                          maxLength: 64
                        animation_url:
                          type: string
                          description: "(Optional) [Polygon only] <br> The Mint API natively supports rich metadata within ERC 721 and ERC 1155, including audio, video and/or HTML. <br> Populate the animation_url field as per the OpenSea metadata spec: <br> https://docs.opensea.io/docs/metadata-standards#metadata-structure"
                        attributes:
                          type: array
                          description: "(Optional) Add attributes to your NFT"
                          items:
                            type: object
                            required:
                              - trait_type
                              - value
                            properties:
                              display_type:
                                type: string
                                description: "Display name of your attribute"
                                default: ""
                                enum:
                                  - boost_number
                                  - boost_percentage
                                  - number
                              trait_type:
                                type: string
                                description: "The name of the trait"
                              value:
                                type: string
                                description: "The value of the trait"
                    - title: "Metadata url"
                      description: "Enter a url to a json file containing the metadata contents"
                      type: string
              required:
                - recipient
                - metadata
  /v1-alpha1/minting/collections/{collectionId}/nfts/{nftName}: # Mint an NFT (Idempotent) (alpha)
    put:
      responses:
        "200":
          description: "Success."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MintResponse"
              examples:
                SolanaPending:
                  description: "Solana pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "solana"
                EVMPending:
                  description: "EVM pending"
                  value:
                    id: "74408f29-8d35-4686-9ca6-cd4a65186e7b"
                    onChain:
                      status: "pending"
                      chain: "ethereum"
                      contractAddress: "0x123456789"
                SolanaExisting:
                  description: "Solana existing"
                  value:
                    id: "example-sol"
                    metadata:
                      name: "My first Mint API NFT"
                      symbol: ""
                      description: "My NFT created via the mint API!"
                      seller_fee_basis_points: 0
                      image: "https://nftstorage.link/ipfs/bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      attributes: []
                      properties:
                        files: []
                        category: "image"
                        creators: []
                    onChain:
                      status: "success"
                      mintHash: "9zb4yNune7rWko38utKVW3mwmXjR3jyVD8vuQZ6fufiG"
                      owner: "5WpDyJ2fUnh7dHG2HRive2S8bS57WYodRX1wPKa1QRYZ"
                      chain: "solana"
                EVMExisting:
                  description: "EVM existing"
                  value:
                    id: "example-evm"
                    metadata:
                      name: "My first Mint API NFT"
                      image: "ipfs://bafkreigbqsmxzkbjgbwtj6exfdt5z3t3swgoysf7hr6vjzddqnmykj6x2u"
                      description: "My NFT created via the mint API!"
                    onChain:
                      status: "success"
                      tokenId: "8"
                      owner: "0x81D9925146d6e13D6E52544Cfcff4907376c6c6d"
                      txId: "0xc4dcb052f5ab1f9885128dd3d58746c71aa10779a14d10742f820e769edfcbf0"
                      contractAddress: "0xc4F90B864F90D52dc863b3932BAD2F1e284e459A"
                      chain: "polygon"

        "400":
          description: "Invalid arguments, please make sure you're following the api specification."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: "Forbidden error, please ensure the credentials are correct."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: "Please try again in a few minutes. If the issue still persists, please contact Crossmint support."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
      tags:
        - Mint
      summary: Mint an NFT (Idempotent) - Compressed
      description: >-
        This pathway allows you to mint NFTs and 
        guarantee idempotency
      operationId: mint-nft-idempotent-alpha
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
        - name: nftName
          in: path
          description: "Name of the NFT, which is used as an idempotency key"
          required: true
          example: "default"
          schema:
            type: string
            default: "my-idempotent-nft-name"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipient:
                  type: string
                  default: "email:replaceme@youruser.com:solana"
                  description: "Recipient address in the format of `<chain>:<address>` or <br> `email:<email_address>:<chain>`.\nSee https://docs.crossmint.com/docs/recipients for more info."
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  oneOf:
                    - title: "Metadata object"
                      description: "See https://docs.crossmint.com/docs/metadata for more info."
                      type: object
                      required:
                        - name
                        - image
                        - description
                      properties:
                        name:
                          type: string
                          description: "The name of your NFT (Max length: 32)"
                          default: "My first Mint API NFT"
                          maxLength: 32
                        image:
                          type: string
                          description: "Direct link to your NFT image"
                          default: "https://www.crossmint.com/assets/crossmint/logo.png"
                        description:
                          type: string
                          description: "A quick and brief description of your NFT (Max length: 64)"
                          default: "My NFT created via the mint API!"
                          maxLength: 64
                        animation_url:
                          type: string
                          description: "(Optional) [Polygon only] <br> The Mint API natively supports rich metadata within ERC 721 and ERC 1155, including audio, video and/or HTML. <br> Populate the animation_url field as per the OpenSea metadata spec: <br> https://docs.opensea.io/docs/metadata-standards#metadata-structure"
                        attributes:
                          type: array
                          description: "(Optional) Add attributes to your NFT"
                          items:
                            type: object
                            required:
                              - trait_type
                              - value
                            properties:
                              display_type:
                                type: string
                                description: "Display name of your attribute"
                                default: ""
                                enum:
                                  - boost_number
                                  - boost_percentage
                                  - number
                              trait_type:
                                type: string
                                description: "The name of the trait"
                              value:
                                type: string
                                description: "The value of the trait"
                    - title: "Metadata url"
                      description: "Enter a url to a json file containing the metadata contents"
                      type: string
              required:
                - recipient
                - metadata
  /2022-06-09/collections/{collectionId}/nfts/{id}: # Mint status
    get:
      responses:
        "200":
          description: "Success."
        "400":
          description: ""
        "404":
          description: ""
      tags:
        - Mint
      summary: Mint Status
      description: Get the status and associated information for a mint operation
      operationId: mint-status
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
        - name: id
          in: path
          description: "Unique ID of the mint as returned as part of the NFT creation response"
          required: true
          example: "default"
          schema:
            type: string
    patch: # Update nft
      responses:
        "204":
          description: ""
        "400":
          description: ""
        "404":
          description: ""
      tags:
        - Edit
      summary: Edit NFT
      description: >-
        Edit a minted NFT's metadata on IPFS.
        <br>
        **This API is subject to change as it is currently in it's alpha form.**
        <br>
        <h2>Editing is not supported for compressed Solana NFTs</h2>
      operationId: edit-nft
      parameters:
        - name: collectionId
          in: path
          description: >-
            Every project can mint to their pre-built collections (with IDs 'default-solana' or 'default-polygon'), 
            or use the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
        - name: id
          in: path
          description: "Unique ID of the mint as returned as part of the NFT creation response"
          required: true
          example: "default"
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  description: "See https://docs.crossmint.com/docs/metadata for more info."
                  type: object
                  required:
                    - name
                    - image
                    - description
                  properties:
                    name:
                      type: string
                      description: "The name of your NFT (Max length: 32)"
                      default: "My edited Mint API NFT"
                      maxLength: 32
                    image:
                      type: string
                      description: "Direct link to your NFT image"
                      default: "https://www.crossmint.com/assets/crossmint/logo.png"
                    description:
                      type: string
                      description: "A quick and brief description of your NFT (Max length: 64)"
                      default: "My NFT edited via the mint API!"
                      maxLength: 64
                    animation_url:
                      type: string
                      description: "(Optional) [Polygon only] <br> The Mint API natively supports rich metadata within ERC 721 and ERC 1155, including audio, video and/or HTML. <br> Populate the animation_url field as per the OpenSea metadata spec: <br> https://docs.opensea.io/docs/metadata-standards#metadata-structure"
                    attributes:
                      type: array
                      description: "(Optional) Add attributes to your NFT"
                      items:
                        type: object
                        required:
                          - trait_type
                          - value
                        properties:
                          display_type:
                            type: string
                            description: "Display name of your attribute"
                            default: ""
                            enum:
                              - boost_number
                              - boost_percentage
                              - number
                          trait_type:
                            type: string
                            description: "The name of the trait"
                          value:
                            type: string
                            description: "The value of the trait"
              required:
                - recipient
                - metadata
  /2022-06-09/collections/: # Create/Get collection
    get: # List collections
      responses:
        "200":
          description: "Success."
        "400":
          description: ""
        "404":
          description: ""
      tags:
        - Collection
      summary: List all collections
      description: List all of your collections on Crossmint
      operationId: list-collections
    post: # Create collection
      responses:
        "200":
          description: "Success."
        "400":
          description: ""
      tags:
        - Collection
      operationId: create-collection
      summary: Create collection
      description: Create a collection with a random UUID
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                chain:
                  description: >-
                    Blockchain you would like to use for this collection
                  type: string
                  default: polygon
                  enum:
                    - polygon
                    - solana
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  description: "See https://docs.crossmint.com/docs/metadata for more info."
                  type: object
                  required:
                    - name
                    - imageUrl
                    - description
                  properties:
                    name:
                      type: string
                      description: "Collection name (Max length: 32)"
                      default: "A new collection"
                      maxLength: 32
                    imageUrl:
                      type: string
                      default: "https://www.crossmint.com/assets/crossmint/logo.png"
                    description:
                      type: string
                      default: "A new collection with its own dedicated smart contract"
                      maxLength: 64
                    symbol:
                      type: string
                      description: "NFT collection symbol (Polygon ONLY)"
              required:
                - chain
                - metadata
  /2022-06-09/collections/{collectionId}: # Create collection (custom id)
    put:
      responses:
        "200":
          description: "Success."
        "400":
          description: ""
      tags:
        - Collection
      summary: Create a collection with a custom provided UUID
      description: Create a collection with a custom provided UUID
      operationId: create-collection-custom
      parameters:
        - name: collectionId
          in: path
          description: "The ID of the named collection, which you will use to create new NFTs and get status"
          required: true
          example: "idempotent-collection-name"
          schema:
            type: string
            default: "idempotent-collection-name"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                chain:
                  description: >-
                    Blockchain you would like to use for this collection
                  type: string
                  default: polygon
                  enum:
                    - polygon
                    - solana
                reuploadLinkedFiles:
                  type: boolean
                  description: "(Optional) Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]"
                metadata:
                  description: "See https://docs.crossmint.com/docs/metadata for more info."
                  type: object
                  required:
                    - name
                    - imageUrl
                    - description
                  properties:
                    name:
                      type: string
                      description: "Collection name (Max length: 32)"
                      default: "A new collection"
                      maxLength: 32
                    imageUrl:
                      type: string
                      default: "https://www.crossmint.com/assets/crossmint/logo.png"
                    description:
                      type: string
                      default: "A new collection with its own dedicated smart contract"
                      maxLength: 64
                    symbol:
                      type: string
                      description: "NFT collection symbol (Polygon ONLY)"
              required:
                - chain
                - metadata
    get: # Get collection info
      responses:
        "200":
          description: "Success."
        "400":
          description: ""
      tags:
        - Collection
      summary: Collection information
      description: Get information about a specific collection
      operationId: collection-info
      parameters:
        - name: collectionId
          in: path
          description: "The ID of the named collection, which you will use to create new NFTs and get status.  Get information on your default collections with names 'default-solana' and 'default-polygon'"
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"

  /v1-alpha1/minting/collections/{collectionId}/royalties:
    description: "Manage the royalties on a collection."
    get:
      tags:
        - Collection
      summary: Fetch royalty configuration
      description: >-
        Fetch the royalty config for a collection, from its current state in the blockchain.
      operationId: get-royalty-information
      parameters:
        - name: collectionId
          in: path
          description: >-
            Collection identifier. For pre-built collections use IDs 'default-solana' or 'default-polygon'.
            use the result of the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint to get the identifier for custom collections.
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
      responses:
        "200":
          description: "Success."
          content:
            application/json:
              schema:
                type: object
                properties:
                  recipients:
                    type: array
                    items:
                      type: object
                      properties:
                        address:
                          type: string
                          description: "Recipient address. e.g., 0x71C..."
                          example: "0x71C..."
                        basisPoints:
                          type: integer
                          description: "A basis point is a standard measure for percentages in finance. One basis point equals 1/100th of 1%, or 0.01%."
                          example: 100
                required:
                  - basisPoints
                  - recipient
        "400":
          description: "Bad Request"
        "404":
          description: "Collection not found"
    put:
      tags:
        - Collection
      summary: Set royalties
      description: >-
        Configure royalties for all NFTs in a collection.
      operationId: edit-royalty-information
      parameters:
        - name: collectionId
          in: path
          description: >-
            Collection identifier. For pre-built collections use IDs 'default-solana' or 'default-polygon'.
            use the result of the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint to get the identifier for custom collections.
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                recipients:
                  description: "List of royalty recipients. Note: EVM collections support only a single recipient. Use a contract splitter as recipient in order to send payments to multiple addresses."
                  type: array
                  items:
                    type: object
                    properties:
                      address:
                        type: string
                        description: "Address where the payments will be received. Note: ENS addresses are not supported."
                        example: "0x71C..."
                      basisPoints:
                        type: integer
                        description: "Proportion of the sale price that will go to the recipient address. A basis point is a standard measure for percentages in finance. One basis point equals 1/100th of 1%, or 0.01%."
                        example: 100
              required:
                - basisPoints
                - recipient
      responses:
        "204":
          description: "No-content success response indicating that the request is being processed."
        "400":
          description: "Bad Request"
        "404":
          description: "Collection not found"
    delete:
      tags:
        - Collection
      summary: Remove royalties
      description: >-
        Remove all royalties from a given collection. No new NFT sales will yield royalties to the creator.
      operationId: disable-royalty-information
      parameters:
        - name: collectionId
          in: path
          description: >-
            Collection identifier. For pre-built collections use IDs 'default-solana' or 'default-polygon'.
            use the result of the [`create-collection`](https://docs.crossmint.com/reference/create-collection) endpoint to get the identifier for custom collections.
          required: true
          example: "default-solana"
          schema:
            type: string
            default: "default-solana"
      responses:
        "204":
          description: "No-content success response indicating that the request is being processed."
        "400":
          description: "Bad Request"
        "404":
          description: "Collection not found"
components:
  securitySchemes:
    clientSecret:
      type: apiKey
      in: header
      name: x-client-secret
    projectId:
      type: apiKey
      in: header
      name: x-project-id
  schemas:
    MintResponse:
      oneOf:
        - title: "SOLANA: ON FIRST MINT REQUEST"
          type: object
          properties:
            id:
              type: string
            onchain:
              type: object
              properties:
                status:
                  type: string
                chain:
                  type: string
              required:
                - status
                - chain
          required:
            - id
            - onchain
        - title: "EVM: ON FIRST MINT REQUEST"
          type: object
          properties:
            id:
              type: string
            onchain:
              type: object
              properties:
                status:
                  type: string
                chain:
                  type: string
                contractAddress:
                  type: string
              required:
                - status
                - chain
                - contractAddress
          required:
            - id
            - onchain
        - title: "SOLANA: ON SUBSEQUENT REQUESTS"
          type: object
          properties:
            id:
              type: string
            metadata:
              type: object
              properties:
                name:
                  type: string
                symbol:
                  type: string
                description:
                  type: string
                seller_fee_basis_points:
                  type: integer
                image:
                  type: string
                attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      trait_type:
                        type: string
                      value:
                        type: string
                properties:
                  type: object
                  properties:
                    files:
                      type: array
                      items:
                        type: object
                        properties:
                          uri:
                            type: string
                          type:
                            type: string
                    category:
                      type: string
                    creators:
                      type: array
                      items:
                        type: object
                        properties:
                          address:
                            type: string
                          share:
                            type: integer
              required:
                - name
                - description
                - image
            onChain:
              type: object
              properties:
                status:
                  type: string
                mintHash:
                  type: string
                owner:
                  type: string
                chain:
                  type: string
              required:
                - status
                - mintHash
                - owner
                - chain
          required:
            - metadata
            - onChain
        - title: "EVM: ON SUBSEQUENT REQUESTS"
          type: object
          properties:
            id:
              type: string
            metadata:
              type: object
              properties:
                name:
                  type: string
                image:
                  type: string
                description:
                  type: string
              required:
                - name
                - image
                - description
            onChain:
              type: object
              properties:
                status:
                  type: string
                tokenId:
                  type: string
                owner:
                  type: string
                txId:
                  type: string
                contractAddress:
                  type: string
                chain:
                  type: string
              required:
                - status
                - tokenId
                - owner
                - txId
                - contractAddress
                - chain
          required:
            - id
            - metadata
            - onChain
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string

Discover other plugins from the crypto category

0 Votes

NFT News Roundup

Get Today's NFT News Headlines As A Clickable Link Roundup!

0 Comments

0 Votes

DAIZY

Deep insights on ETFs, stocks, cryptos. Institutional-grade data: performance, risk, sustainability, research.

0 Comments

0 Votes

CoinCap

Get cryptocurrency information from CoinCap.

0 Comments

0 Votes

CCData.io

Access the latest crypto prices and news aggregated by CCData.io (formerly CryptoCompare.com).

0 Comments

0 Votes

Defillama

Retrieve data on DeFi protocols and blockchains.

0 Comments

0 Votes

sic

Your gateway to crypto. Explore prices, accounts, and transactions on blockchains, starting with Ethereum.

0 Comments

0 Votes

CheckTheChain

Look for anything on the blockchain and get instant analysis.

0 Comments

0 Votes

Bitcoin Sentiment

Track the current price of Bitcoin and the market sentiment based on the last 20 news media mentions!

0 Comments

0 Votes

P/E For NFTs

Get the price to earnings ratio for any NFT collection!

0 Comments

0 Votes

Crypto Price Checker

A Crypto Prices app that takes a pair of crypto or fiat tickers and returns the current price of the pair.

0 Comments

0 Votes

Crypto ERC20 Scout

Browse ERC20 tokens on EVM blockchains. Includes address resolution, symbol/tag search, explorer links, and pricing.

0 Comments

0 Votes

Smarter Contracts

Analyze smart contracts and tokens on Ethereum.

0 Comments

0 Votes

Mobula

Fetching real-time data for all crypto & blockchain metrics.

0 Comments

0 Votes

Crypto Market News

It's your go-to solution for real-time cryptocurrency price updates, market insights, and the latest news.

0 Comments

0 Votes

NFTs

Get the important details of any NFT collection and ask for insights based on that data!

0 Comments

0 Votes

Crypto Pulse

From News to Profit: Decode Crypto's Market Impact with Ease. Instantly, analyse latest crypto news.

0 Comments

0 Votes

SignalPlus

Live data on crypto, NFTs, DeFi. Spot/derivatives. A must for traders.

0 Comments

0 Votes

MetaPath

Query info on cryptos, NFTs, tokens, coins, Defi and Web3.

0 Comments

0 Votes

MintbaseSearch

Find any NFT data on the NEAR Protocol.

0 Comments

0 Votes

Toolblox

Text to smart-contract. Describe a process to generate a smart-contract and deploy to any blockchain.

0 Comments

0 Votes

Telescope Labs

Data retrieval, analysis and visualizations related to web3 games who are onboarded as a blockchain game.

0 Comments

0 Votes

TokenInsights

Get realtime crypto price, BTC, ETH, BNB, and the latest insights.The latest coin news and airdrop opportunities.

0 Comments

0 Votes

CryptoMation

Crypto transactions, addresses, balances, conversions for any blockchain (Ethereum, Binance, Near, Tron, etc.)

0 Comments

0 Votes

NFT Guru

Discover current prices of NFTs across major platforms and keep track of the rapidly changing marketplace with real-time

0 Comments

0 Votes

Alchemy

Request real-time blockchain data for chains like Ethereum, Polygon, Arbitrum and Optimism through natural language.

0 Comments

0 Votes

Binance coin API Plugin

Plugin for retrieving cryptocurrency information from the Binance coin API.

0 Comments