{"openapi":"3.0.3","info":{"title":"Capy public API","version":"1.0.0","description":"Read only NFT data for Robinhood Chain (chain id 4663) from Capy.Family: collections, statistics, listings, offers, sales, tokens, wallets and signed orders. Anonymous: 60 requests a minute per IP. With an X-API-Key header: 600 a minute. Create keys at https://capy.family/developers/ after signing in."},"servers":[{"url":"https://capy.family/api/public/v1"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Collection":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"firstSeenAt":{"type":"integer"},"deployedBlock":{"type":"integer","nullable":true},"stats":{"type":"object","properties":{"floorWei":{"type":"string","description":"Integer amount in wei as a decimal string","nullable":true},"listed":{"type":"integer"},"volumeWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume24hWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume7dWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"sales":{"type":"integer"},"owners":{"type":"integer"},"supply":{"type":"integer"}},"required":[],"nullable":true}},"required":["address"]},"Order":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]},"Sale":{"type":"object","properties":{"txHash":{"type":"string"},"logIndex":{"type":"integer"},"orderHash":{"type":"string","nullable":true},"block":{"type":"integer"},"timestamp":{"type":"integer"},"source":{"type":"string"},"kind":{"type":"string"},"tokenId":{"type":"string"},"seller":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"buyer":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"}},"required":["txHash","block","timestamp","tokenId","seller","buyer","priceWei"]},"Stats":{"type":"object","properties":{"floorWei":{"type":"string","description":"Integer amount in wei as a decimal string","nullable":true},"listed":{"type":"integer"},"volumeWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume24hWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume7dWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"sales":{"type":"integer"},"owners":{"type":"integer"},"supply":{"type":"integer"}},"required":[]}}},"security":[{},{"apiKey":[]}],"paths":{"/collections":{"get":{"summary":"Collections ranked by 24 hour volume or by newest deployment","parameters":[{"name":"sort","in":"query","required":false,"description":"top (24 hour volume) or newest","schema":{"type":"string","enum":["top","newest"]}},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"offset","in":"query","required":false,"description":"Rows to skip","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"Collections","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"firstSeenAt":{"type":"integer"},"deployedBlock":{"type":"integer","nullable":true},"stats":{"type":"object","properties":{"floorWei":{"type":"string","description":"Integer amount in wei as a decimal string","nullable":true},"listed":{"type":"integer"},"volumeWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume24hWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume7dWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"sales":{"type":"integer"},"owners":{"type":"integer"},"supply":{"type":"integer"}},"required":[],"nullable":true}},"required":["address"]}}},"required":["schema","items"]}}}}}}},"/collections/{address}":{"get":{"summary":"One collection with statistics and its deployer","parameters":[{"name":"address","in":"path","required":true,"description":"Contract address","schema":{"type":"string"}}],"responses":{"200":{"description":"Collection","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"name":{"type":"string","nullable":true},"symbol":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"firstSeenAt":{"type":"integer"},"deployedBlock":{"type":"integer","nullable":true},"stats":{"type":"object","properties":{"floorWei":{"type":"string","description":"Integer amount in wei as a decimal string","nullable":true},"listed":{"type":"integer"},"volumeWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume24hWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"volume7dWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"sales":{"type":"integer"},"owners":{"type":"integer"},"supply":{"type":"integer"}},"required":[],"nullable":true},"deployer":{"type":"string","pattern":"^0x[0-9a-f]{40}$","nullable":true},"deployKind":{"type":"string","nullable":true},"deployTx":{"type":"string","nullable":true}},"required":["address"]}}}},"404":{"description":"Unknown or not an ERC721 collection"}}}},"/collections/{address}/listings":{"get":{"summary":"Live ETH and WETH listings, cheapest first, with Capy book listings merged in","parameters":[{"name":"address","in":"path","required":true,"description":"Contract address","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Listings","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]}}},"required":["schema","items"]}}}}}}},"/collections/{address}/offers":{"get":{"summary":"Live WETH offers on tokens or on the whole collection","parameters":[{"name":"address","in":"path","required":true,"description":"Contract address","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"bid (token offers, default) or collection_offer","schema":{"type":"string","enum":["bid","collection_offer"]}},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Offers","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]}}},"required":["schema","items"]}}}}}}},"/collections/{address}/sales":{"get":{"summary":"Sales, newest first","parameters":[{"name":"address","in":"path","required":true,"description":"Contract address","schema":{"type":"string"}},{"name":"tokenId","in":"query","required":false,"description":"Restrict to one token"},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"offset","in":"query","required":false,"description":"Rows to skip","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"Sales","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"txHash":{"type":"string"},"logIndex":{"type":"integer"},"orderHash":{"type":"string","nullable":true},"block":{"type":"integer"},"timestamp":{"type":"integer"},"source":{"type":"string"},"kind":{"type":"string"},"tokenId":{"type":"string"},"seller":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"buyer":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"}},"required":["txHash","block","timestamp","tokenId","seller","buyer","priceWei"]}}},"required":["schema","items"]}}}}}}},"/tokens/{address}/{tokenId}":{"get":{"summary":"One token: owner, live listings, last sale","parameters":[{"name":"address","in":"path","required":true,"description":"Contract address","schema":{"type":"string"}},{"name":"tokenId","in":"path","required":true,"description":"Token id","schema":{"type":"string"}}],"responses":{"200":{"description":"Token","content":{"application/json":{"schema":{"type":"object","properties":{"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string"},"owner":{"type":"string","pattern":"^0x[0-9a-f]{40}$","nullable":true},"ownerBlock":{"type":"integer","nullable":true},"listings":{"type":"array","items":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]}},"lastSale":{"type":"object","properties":{"txHash":{"type":"string"},"logIndex":{"type":"integer"},"orderHash":{"type":"string","nullable":true},"block":{"type":"integer"},"timestamp":{"type":"integer"},"source":{"type":"string"},"kind":{"type":"string"},"tokenId":{"type":"string"},"seller":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"buyer":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"}},"required":["txHash","block","timestamp","tokenId","seller","buyer","priceWei"],"nullable":true}},"required":["collection","tokenId"]}}}}}}},"/wallets/{address}/tokens":{"get":{"summary":"Tokens a wallet holds (ERC721 collections the index knows)","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet address","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Tokens","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string"},"name":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["collection","tokenId"]}}},"required":["schema","items"]}}}}}}},"/wallets/{address}/listings":{"get":{"summary":"Live listings made by a wallet","parameters":[{"name":"address","in":"path","required":true,"description":"Wallet address","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows per page (1 to 100)","schema":{"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Listings","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]}}},"required":["schema","items"]}}}}}}},"/orders/{orderHash}":{"get":{"summary":"One signed Seaport order. Capy book orders carry their signature; mirrored open orders too; zone restricted orders carry parameters only.","parameters":[{"name":"orderHash","in":"path","required":true,"description":"Seaport order hash","schema":{"type":"string"}}],"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"type":"string"},"order":{"type":"object","properties":{"orderHash":{"type":"string"},"source":{"type":"string","enum":["capy","opensea"]},"kind":{"type":"string","enum":["listing","bid","collection_offer","trait_offer"]},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"tokenId":{"type":"string","nullable":true},"maker":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"priceWei":{"type":"string","description":"Integer amount in wei as a decimal string"},"currency":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"symbol":{"type":"string"},"orderType":{"type":"integer"},"zone":{"type":"string","pattern":"^0x[0-9a-f]{40}$"},"restricted":{"type":"boolean","description":"True when a zone must co sign the fulfilment (OpenSea signed zone); such orders are fulfilled through Capy, not directly."},"startTime":{"type":"integer"},"endTime":{"type":"integer"}},"required":["orderHash","kind","collection","maker","priceWei"]},"parameters":{"type":"object"},"signature":{"type":"string","nullable":true},"fulfillment":{"type":"string","enum":["direct","restricted_zone"]}},"required":["order","parameters","fulfillment"]}}}},"404":{"description":"Unknown or no longer active"}}}},"/openapi.json":{"get":{"summary":"This document","responses":{"200":{"description":"OpenAPI 3.0 document"}}}}}}