{"openapi":"3.1.0","info":{"title":"Aurora Partner API","version":"1.0.0","description":"Read-only published NFT releases and collectible sales. Ask an Aurora administrator for a partner key. Keys are for server-to-server use. Supply is a published snapshot; unknown counts are null. Allowlist wallets, proofs, private drafts and unrevealed artwork are never returned. Prices exclude additional platform fees and gas. Times are UTC ISO 8601; null phase start means immediate and null phase end means no scheduled end."},"servers":[{"url":"https://api.aurora.cards"}],"externalDocs":{"description":"Partner integration guide","url":"https://aurora.cards/doc/partner-api/"},"security":[{"partnerKey":[]}],"paths":{"/v1/mints":{"get":{"operationId":"listMints","summary":"List upcoming, present and past mints","parameters":[{"name":"period","in":"query","description":"Upcoming includes coming-soon previews; present includes live and paused; past includes ended and sold-out releases.","schema":{"type":"string","enum":["all","upcoming","present","past"],"default":"all"}},{"name":"chainId","in":"query","schema":{"type":"integer","minimum":1}},{"name":"q","in":"query","schema":{"type":"string","maxLength":100}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":48,"default":24}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":1000000,"default":0}}],"responses":{"200":{"headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Requests allowed per key per minute."},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests remaining in the current key window."},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Key window reset, Unix seconds."}},"description":"Published mint snapshots, including historical releases. Present includes paused mints.","content":{"application/json":{"schema":{"type":"object","required":["data","pagination","generatedAt","dataSource"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Mint"}},"pagination":{"type":"object","required":["offset","limit","total","nextOffset"],"properties":{"offset":{"type":"integer"},"limit":{"type":"integer"},"total":{"type":"integer"},"nextOffset":{"type":["integer","null"],"description":"Use as offset for the next page; null means finished. Deduplicate changing results by id."}}},"generatedAt":{"type":"string","format":"date-time","description":"Response time, not an on-chain observation time."},"dataSource":{"const":"published-snapshot"}}}}}},"400":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"401":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"405":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"429":{"description":"Key or IP rate limit reached. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds until retry."}}},"503":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}}}}},"/v1/mints/{id}":{"get":{"operationId":"getMint","summary":"Get one published mint with all phases and public artwork links","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The opaque id returned by listMints. URL-encode it."}],"responses":{"200":{"description":"Mint snapshot","headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Requests allowed per key per minute."},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests remaining in the current key window."},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Key window reset, Unix seconds."}},"content":{"application/json":{"schema":{"type":"object","required":["data","generatedAt","dataSource"],"properties":{"data":{"$ref":"#/components/schemas/Mint"},"generatedAt":{"type":"string","format":"date-time","description":"Response time, not an on-chain observation time."},"dataSource":{"const":"published-snapshot"}}}}}},"400":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"401":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"404":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"405":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}},"429":{"description":"Key or IP rate limit reached. Wait before retrying.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds until retry."}}},"503":{"description":"API error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["INVALID_REQUEST","UNAUTHORIZED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","TEMPORARILY_UNAVAILABLE"]},"message":{"type":"string"},"fields":{"type":"array","items":{"type":"string"},"description":"Present for invalid query fields; credentials are never echoed."}}}}}}}}}}}},"components":{"securitySchemes":{"partnerKey":{"type":"http","scheme":"bearer","description":"A key created in Aurora Admin → API Configuration → Partner API. 60 requests per minute per key; an additional 120 per minute IP limit applies. Respect Retry-After on 429."}},"schemas":{"Mint":{"type":"object","required":["id","collectionKey","current","kind","name","description","period","status","chain","contractAddress","contractType","standard","supply","startsAt","endsAt","updatedAt","verified","links","images","phases"],"properties":{"id":{"type":"string"},"collectionKey":{"type":"string"},"current":{"type":"boolean"},"kind":{"enum":["nft","collectibles"]},"name":{"type":"string"},"description":{"type":"string"},"period":{"enum":["upcoming","present","past"]},"status":{"enum":["coming-soon","upcoming","live","paused","ended","sold-out"]},"chain":{"type":"object","required":["id","name","currency","decimals"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"currency":{"type":"string"},"decimals":{"type":"integer"}}},"contractAddress":{"type":"string"},"contractType":{"enum":["ERC721C","ERC1155C","AuroraCollectibles"]},"standard":{"enum":["ERC721","ERC1155"]},"supply":{"type":"object","required":["maximum","minted","remaining","unit"],"description":"NFT counts apply to this release. Collectible sale-units sum sale allocations and may mix packs and direct items; they are not unique tokens or collection lifetime supply. Collectible minted and remaining counts are currently null.","properties":{"maximum":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Decimal integer string; null means unknown or no configured cap."},"minted":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Decimal integer string; null means unknown or no configured cap."},"remaining":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Decimal integer string; null means unknown or no configured cap."},"unit":{"enum":["nfts","sale-units"]}}},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"updatedAt":{"type":"string","format":"date-time","description":"Saved record timestamp, not a live chain read."},"verified":{"type":"boolean"},"links":{"type":"object","required":["mint","website","x","discord","telegram"],"properties":{"mint":{"type":"string","format":"uri"},"website":{"type":["string","null"]},"x":{"type":["string","null"]},"discord":{"type":["string","null"]},"telegram":{"type":["string","null"]}}},"images":{"type":"object","required":["pfp","banner","social"],"description":"Absolute public artwork links on aurora.cards. A published placeholder may be used.","properties":{"pfp":{"type":"string","format":"uri"},"banner":{"type":"string","format":"uri"},"social":{"type":"string","format":"uri"}}},"phases":{"type":"array","items":{"$ref":"#/components/schemas/Phase"}}}},"Phase":{"type":"object","required":["id","name","status","startsAt","endsAt","price","access","walletLimit","supply","minted","excludePreviousPhaseMinters","pack"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"enum":["coming-soon","upcoming","live","paused","ended"]},"startsAt":{"type":["string","null"],"format":"date-time"},"endsAt":{"type":["string","null"],"format":"date-time"},"price":{"type":"object","required":["baseUnits","formatted","currency","decimals"],"properties":{"baseUnits":{"type":"string","pattern":"^[0-9]+$","description":"Native currency base units, excluding platform fees and gas."},"formatted":{"type":"string"},"currency":{"type":"string"},"decimals":{"type":"integer"}}},"access":{"enum":["public","allowlist"]},"walletLimit":{"type":"integer","description":"Zero means no configured wallet limit."},"supply":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Decimal integer string; null means unknown or no configured cap."},"minted":{"type":["string","null"],"pattern":"^[0-9]+$","description":"Decimal integer string; null means unknown or no configured cap."},"excludePreviousPhaseMinters":{"type":"boolean"},"pack":{"type":["object","null"],"required":["id","name","openingStartsAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"openingStartsAt":{"type":["string","null"],"format":"date-time"}}}}}}}}