User settings retriever

[apis/nftport/v0/User settings retriever]


Retrieve your NFTPort settings to check your usage and limits. User settings: https://docs.nftport.xyz/docs/nftport/?search=user-settings


Keywords: nftport, settings, quota

Input ports

  • params: {"api_key": string}

    Receives the query parameters. Rerefence: https://docs.nftport.xyz/docs/nftport/?search=user-settings#Request

Output ports

  • data:

    {
      "response": "OK",
      "profile": {"name": string, "email": string, "joined_date": string},
      "subscription_period": {"start_date": string, "end_date": string},
      "data_usage_and_limits": {
        "data_usage": {optional "subscription_data_requests_made": number},
        "data_limits": {
          optional "subscription_data_requests_included": number,
          "max_data_requests_per_second": number,
          "max_data_requests_per_month": number
        }
      },
      "minting_usage_and_limits": {
        "polygon": {
          "minting_usage": {
            "total_nfts_minted": number,
            optional "subscription_nfts_minted": number
          },
          "minting_limits": {
            "max_mints": number,
            optional "subscription_mints_included": number
          },
          "contract_deployment_usage": {
            "total_contracts_deployed": number,
            optional "subscription_contracts_deployed": number
          },
          "contract_deployment_limits": {
            "max_contracts": number,
            optional "subscription_contracts_included": number
          }
        },
        "rinkeby": {
          "minting_usage": {
            "total_nfts_minted": number,
            optional "subscription_nfts_minted": number
          },
          "minting_limits": {
            "max_mints": number,
            optional "subscription_mints_included": number
          },
          "contract_deployment_usage": {
            "total_contracts_deployed": number,
            optional "subscription_contracts_deployed": number
          },
          "contract_deployment_limits": {
            "max_contracts": number,
            optional "subscription_contracts_included": number
          }
        }
      }
    }

    Sends the query response. Reference: https://docs.nftport.xyz/docs/nftport/?search=user-settings#Responses

  • response:

    {"status": number, "headers": {string: any}, "body": string}

    Sends the original response.

  • error: {"error": string, "details": any}

    Sends the error, if any

Last updated