OpenSea · Schema

InstantApiKeyResponse

Instant API key response

NFTMarketplaceWeb3BlockchainTradingDigital Assets

Properties

Name Type Description
api_key string The API key to use in X-API-KEY header
name string Key name for identification and revocation
expires_at string ISO-8601 timestamp when the key expires
rate_limits object Rate limits for this key
upgrade_url string URL to upgrade to higher rate limits
View JSON Schema on GitHub

JSON Schema

InstantApiKeyResponse.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opensea.io/schemas/InstantApiKeyResponse",
  "title": "InstantApiKeyResponse",
  "type": "object",
  "description": "Instant API key response",
  "properties": {
    "api_key": {
      "type": "string",
      "description": "The API key to use in X-API-KEY header"
    },
    "name": {
      "type": "string",
      "description": "Key name for identification and revocation"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO-8601 timestamp when the key expires"
    },
    "rate_limits": {
      "$ref": "#/components/schemas/RateLimitsResponse",
      "description": "Rate limits for this key"
    },
    "upgrade_url": {
      "type": "string",
      "description": "URL to upgrade to higher rate limits"
    }
  },
  "required": [
    "api_key",
    "expires_at",
    "name",
    "rate_limits",
    "upgrade_url"
  ]
}