Returns a single provider. The path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_ computed across the provider’s eligible vaults.
GET
/
v1
/
providers
/
{id}
Get Provider By Id
curl --request GET \ --url https://persephone.superform.xyz/v1/providers/{id} \ --header 'SF-API-KEY: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Superform","description":"Superform is the user-owned neobank enabling single-signature execution of arbitrary actions across chains and optimized vaults.","colors":{"primary":"#254544","light":"#A9D9D7","dark":"#436C6A"},"logo":{"light":"https://mintcdn.com/superform-cb7ef652/OJBpJ8wuYZYVdHmI/logo/light.svg?fit=max\u0026auto=format\u0026n=OJBpJ8wuYZYVdHmI\u0026q=85\u0026s=61bbf5e05afb25fbcf7b210106c3ea0c","dark":"https://mintcdn.com/superform-cb7ef652/z2T81BwwQxcF77_b/images/Superform_horizontal_white.png?fit=max\u0026auto=format\u0026n=z2T81BwwQxcF77_b\u0026q=85\u0026s=e703e7bacf449dedc26b6cbf5aebbdf5"},"favicon":"https://mintcdn.com/superform-cb7ef652/fURJBpj2e_Kvfm29/images/superform_square.svg?fit=max\u0026auto=format\u0026n=fURJBpj2e_Kvfm29\u0026q=85\u0026s=f3c715b9a05ee986959b055ac0ccd9bf","navbar":{"links":[{"href":"https://os.superform.xyz","label":"SuperformOS"}],"primary":{"type":"button","label":"Superform App","href":"https://app.superform.xyz"}},"footer":{"socials":{"x":"https://twitter.com/superformxyz","github":"https://github.com/superform-xyz","discord":"https://discord.gg/superform"}},"seo":{"indexing":"all"},"thumbnails":{"appearance":"light","background":"https://mintcdn.com/superform-cb7ef652/dfweDKOKcpENVykY/images/docs_3_seo.png?fit=max\u0026auto=format\u0026n=dfweDKOKcpENVykY\u0026q=85\u0026s=0520edd283c9020e8e697543f36f76af"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Superform App","icon":"clapperboard-play","href":"https://app.superform.xyz"},{"anchor":"SuperformOS","icon":"gauge-high","href":"https://os.superform.xyz"},{"anchor":"GitHub","icon":"github","href":"https://github.com/superform-xyz"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superform-cb7ef652","hasAudioNarration":false,"actualSubdomain":"superform-cb7ef652","customDomains":["docs.superform.xyz"],"gitSource":{"type":"github","owner":"superform-xyz","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8099d6cd5c9678e1f5d63","collectionId":"ed3bfa5a-8902-493c-9444-05eeeb0a124f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8099d6cd5c9678e1f5d63"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad8099d6cd5c9678e1f5d63","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Operate","count":31},{"language":"default","tag":"Build","count":20},{"language":"default","tag":"API Reference","count":19},{"language":"default","tag":"Learn","count":11},{"language":"default","tag":"Vault Operations","count":11},{"language":"default","tag":"SuperVaults Validator Network","count":9},{"language":"default","tag":"Earn","count":8},{"language":"default","tag":"SuperVaults","count":7},{"language":"default","tag":"Strategy Canvas","count":6},{"language":"default","tag":"Reference","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/restapiservice/get-provider-by-id","slug":"/api-reference/restapiservice/get-provider-by-id","pageMetadata":{"title":"Get Provider By Id","description":"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/providers/{id}","href":"/api-reference/restapiservice/get-provider-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a single provider. The \", \" path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_\", \" computed across the provider’s eligible vaults.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Provider By Id","description":"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/providers/{id}","href":"/api-reference/restapiservice/get-provider-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Provider By Id","description":"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.","operationId":"RestAPIService_GetProviderById","responses":{"200":"48319432-99a9-42c8-aee5-b9314351405e","default":"31b07386-bf3d-4dfd-870a-bc07b5581143"},"parameters":["f7e60455-c59a-4bab-b610-871b699545e1"],"tags":["RestAPIService"],"method":"get","type":"path","servers":["deb55e91-7ce8-4a7c-a5f5-5101be18638b"],"security":["de4d6718-adcc-4bbd-9eeb-015aa568d516"],"path":"/v1/providers/{id}","baseUrlOptions":["https://persephone.superform.xyz"],"title":"Get Provider By Id","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f7e60455-c59a-4bab-b610-871b699545e1":{"name":"id","description":"Provider id, vanity_url, or slugified name. The BE resolves all three (id first, then vanity_url, then slug).","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Provider id, vanity_url, or slugified name. The BE resolves all three (id first, then vanity_url, then slug).","uniqueKey":"","typeLabel":"string"}}},"responses":{"48319432-99a9-42c8-aee5-b9314351405e":{"description":"A successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"provider.id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"provider.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"provider.description","typeLabel":"string"},"provider_type":{"type":"string","example":"protocol","description":"Provider type. Possible values: protocol, curator, issuer","uniqueKey":"provider.provider_type","typeLabel":"string"},"category":{"type":"array","items":{"type":"string","uniqueKey":"provider.category.items.[INDEX]","typeLabel":"string"},"uniqueKey":"provider.category","typeLabel":"string[]"},"chain_ids":{"type":"array","items":{"type":"string","format":"uint64","uniqueKey":"provider.chain_ids.items.[INDEX]","typeLabel":"string\u003cuint64>"},"uniqueKey":"provider.chain_ids","typeLabel":"string\u003cuint64>[]"},"is_hidden":{"type":"boolean","uniqueKey":"provider.is_hidden","typeLabel":"boolean"},"vanity_url":{"type":"string","example":"morpho-blue","description":"Optional admin-set URL slug. When non-empty it overrides the slugified name as the provider's canonical slug.","uniqueKey":"provider.vanity_url","typeLabel":"string"},"num_vaults":{"type":"string","format":"int64","uniqueKey":"provider.num_vaults","typeLabel":"string\u003cint64>"},"tagline":{"type":"string","uniqueKey":"provider.tagline","typeLabel":"string"},"status_message":{"type":"string","uniqueKey":"provider.status_message","typeLabel":"string"},"metadata":{"type":"object","properties":{"audits":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time","uniqueKey":"provider.metadata.audits.items.[INDEX].date","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","uniqueKey":"provider.metadata.audits.items.[INDEX].url","typeLabel":"string"},"auditor":{"type":"string","uniqueKey":"provider.metadata.audits.items.[INDEX].auditor","typeLabel":"string"}},"uniqueKey":"provider.metadata.audits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"provider.metadata.audits","typeLabel":"object[]"},"faq":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","uniqueKey":"provider.metadata.faq.items.[INDEX].question","typeLabel":"string"},"answer":{"type":"string","uniqueKey":"provider.metadata.faq.items.[INDEX].answer","typeLabel":"string"}},"title":"--- metadata types ---","uniqueKey":"provider.metadata.faq.items.[INDEX]","typeLabel":"--- metadata types --- · object"},"uniqueKey":"provider.metadata.faq","typeLabel":"--- metadata types --- · object[]"},"graphics":{"type":"object","properties":{"icon":{"type":"string","uniqueKey":"provider.metadata.graphics.icon","typeLabel":"string"},"header":{"type":"string","uniqueKey":"provider.metadata.graphics.header","typeLabel":"string"},"watermark":{"type":"string","uniqueKey":"provider.metadata.graphics.watermark","typeLabel":"string"}},"uniqueKey":"provider.metadata.graphics","typeLabel":"object"},"links":{"type":"object","properties":{"discord":{"type":"string","uniqueKey":"provider.metadata.links.discord","typeLabel":"string"},"documentation":{"type":"string","uniqueKey":"provider.metadata.links.documentation","typeLabel":"string"},"github":{"type":"string","uniqueKey":"provider.metadata.links.github","typeLabel":"string"},"medium":{"type":"string","uniqueKey":"provider.metadata.links.medium","typeLabel":"string"},"telegram":{"type":"string","uniqueKey":"provider.metadata.links.telegram","typeLabel":"string"},"twitter":{"type":"string","uniqueKey":"provider.metadata.links.twitter","typeLabel":"string"},"website":{"type":"string","uniqueKey":"provider.metadata.links.website","typeLabel":"string"}},"uniqueKey":"provider.metadata.links","typeLabel":"object"}},"uniqueKey":"provider.metadata","typeLabel":"object"},"deployers":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","uniqueKey":"provider.deployers.items.[INDEX].address","typeLabel":"string"},"name":{"type":"string","uniqueKey":"provider.deployers.items.[INDEX].name","typeLabel":"string"},"is_verified":{"type":"boolean","uniqueKey":"provider.deployers.items.[INDEX].is_verified","typeLabel":"boolean"},"admin_status":{"type":"string","example":"approved","description":"Admin approval status for the deployer-provider association. One of: enqueued, approved, rejected.","uniqueKey":"provider.deployers.items.[INDEX].admin_status","typeLabel":"string"},"created_at":{"type":"string","uniqueKey":"provider.deployers.items.[INDEX].created_at","typeLabel":"string"}},"uniqueKey":"provider.deployers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"provider.deployers","typeLabel":"object[]"},"users":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"provider.users.items.[INDEX].name","typeLabel":"string"},"role":{"type":"string","uniqueKey":"provider.users.items.[INDEX].role","typeLabel":"string"},"account_id":{"type":"string","description":"Product Account that holds this provider-scoped role.","uniqueKey":"provider.users.items.[INDEX].account_id","typeLabel":"string"}},"uniqueKey":"provider.users.items.[INDEX]","typeLabel":"object"},"title":"these are admins","uniqueKey":"provider.users","typeLabel":"these are admins · object[]"},"stats_basic":{"type":"object","properties":{"tvl_total":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total","typeLabel":"number\u003cdouble>"},"tvl_superform":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform","typeLabel":"number\u003cdouble>"},"tvl_total_change_day":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total_change_day","typeLabel":"number\u003cdouble>"},"tvl_total_change_week":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total_change_week","typeLabel":"number\u003cdouble>"},"tvl_total_change_month":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total_change_month","typeLabel":"number\u003cdouble>"},"tvl_total_change_year":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total_change_year","typeLabel":"number\u003cdouble>"},"tvl_total_change_all_time":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_total_change_all_time","typeLabel":"number\u003cdouble>"},"tvl_superform_change_day":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform_change_day","typeLabel":"number\u003cdouble>"},"tvl_superform_change_week":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform_change_week","typeLabel":"number\u003cdouble>"},"tvl_superform_change_month":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform_change_month","typeLabel":"number\u003cdouble>"},"tvl_superform_change_year":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform_change_year","typeLabel":"number\u003cdouble>"},"tvl_superform_change_all_time":{"type":"number","format":"double","uniqueKey":"provider.stats_basic.tvl_superform_change_all_time","typeLabel":"number\u003cdouble>"}},"uniqueKey":"provider.stats_basic","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"provider.created_at","typeLabel":"string\u003cdate-time>"},"admin_status":{"type":"string","example":"approved","description":"Admin approval status for the provider. One of: enqueued, approved, rejected.","uniqueKey":"provider.admin_status","typeLabel":"string"},"auto_list_vaults":{"type":"boolean","example":false,"description":"Whether newly approved vaults for this provider should be auto-listed. Defaults to false.","uniqueKey":"provider.auto_list_vaults","typeLabel":"boolean"},"slug":{"type":"string","example":"morpho-blue","description":"Canonical URL-safe slug (vanity_url when set, else slugified name). Unique across providers.","uniqueKey":"provider.slug","typeLabel":"string"},"chains":{"type":"array","items":{"type":"object","properties":{"chain_id":{"type":"string","format":"uint64","uniqueKey":"provider.chains.items.[INDEX].chain_id","typeLabel":"string\u003cuint64>"},"name":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].name","typeLabel":"string"},"icon":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].icon","typeLabel":"string"},"is_l1":{"type":"boolean","uniqueKey":"provider.chains.items.[INDEX].is_l1","typeLabel":"boolean"},"rpcs":{"type":"array","items":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].rpcs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"provider.chains.items.[INDEX].rpcs","typeLabel":"string[]"},"explorers":{"type":"array","items":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].explorers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"provider.chains.items.[INDEX].explorers","typeLabel":"string[]"},"currency_name":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].currency_name","typeLabel":"string"},"currency_symbol":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].currency_symbol","typeLabel":"string"},"currency_icon":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].currency_icon","typeLabel":"string"},"currency_decimals":{"type":"integer","format":"int32","uniqueKey":"provider.chains.items.[INDEX].currency_decimals","typeLabel":"integer\u003cint32>"},"currency_min_gas":{"type":"string","uniqueKey":"provider.chains.items.[INDEX].currency_min_gas","typeLabel":"string"}},"title":"Chain represents a blockchain network","uniqueKey":"provider.chains.items.[INDEX]","typeLabel":"Chain represents a blockchain network · object"},"description":"Pre-resolved chains (id/name/icon) for the chains this provider operates on. Populated on provider-detail responses.","uniqueKey":"provider.chains","typeLabel":"Chain represents a blockchain network · object[]"},"highest_apy_day":{"type":"number","format":"double","uniqueKey":"provider.highest_apy_day","typeLabel":"number\u003cdouble>"},"highest_apy_week":{"type":"number","format":"double","uniqueKey":"provider.highest_apy_week","typeLabel":"number\u003cdouble>"},"highest_apy_month":{"type":"number","format":"double","uniqueKey":"provider.highest_apy_month","typeLabel":"number\u003cdouble>"},"highest_apy_year":{"type":"number","format":"double","uniqueKey":"provider.highest_apy_year","typeLabel":"number\u003cdouble>"}},"title":"Provider represents a DeFi protocol","uniqueKey":"provider","typeLabel":"Provider represents a DeFi protocol · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"provider":{"id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","provider_type":"protocol","category":["\u003cstring>"],"chain_ids":["\u003cstring>"],"is_hidden":true,"vanity_url":"morpho-blue","num_vaults":"\u003cstring>","tagline":"\u003cstring>","status_message":"\u003cstring>","metadata":{"audits":[{"date":"2023-11-07T05:31:56Z","url":"\u003cstring>","auditor":"\u003cstring>"}],"faq":[{"question":"\u003cstring>","answer":"\u003cstring>"}],"graphics":{"icon":"\u003cstring>","header":"\u003cstring>","watermark":"\u003cstring>"},"links":{"discord":"\u003cstring>","documentation":"\u003cstring>","github":"\u003cstring>","medium":"\u003cstring>","telegram":"\u003cstring>","twitter":"\u003cstring>","website":"\u003cstring>"}},"deployers":[{"address":"\u003cstring>","name":"\u003cstring>","is_verified":true,"admin_status":"approved","created_at":"\u003cstring>"}],"users":[{"name":"\u003cstring>","role":"\u003cstring>","account_id":"\u003cstring>"}],"stats_basic":{"tvl_total":123,"tvl_superform":123,"tvl_total_change_day":123,"tvl_total_change_week":123,"tvl_total_change_month":123,"tvl_total_change_year":123,"tvl_total_change_all_time":123,"tvl_superform_change_day":123,"tvl_superform_change_week":123,"tvl_superform_change_month":123,"tvl_superform_change_year":123,"tvl_superform_change_all_time":123},"created_at":"2023-11-07T05:31:56Z","admin_status":"approved","auto_list_vaults":false,"slug":"morpho-blue","chains":[{"chain_id":"\u003cstring>","name":"\u003cstring>","icon":"\u003cstring>","is_l1":true,"rpcs":["\u003cstring>"],"explorers":["\u003cstring>"],"currency_name":"\u003cstring>","currency_symbol":"\u003cstring>","currency_icon":"\u003cstring>","currency_decimals":123,"currency_min_gas":"\u003cstring>"}],"highest_apy_day":123,"highest_apy_week":123,"highest_apy_month":123,"highest_apy_year":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"31b07386-bf3d-4dfd-870a-bc07b5581143":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string","uniqueKey":"details.items.[INDEX].@type","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","details":[{"@type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"de4d6718-adcc-4bbd-9eeb-015aa568d516":{"SF-API-KEY":{"type":"apiKey","description":"API key required for authentication. Use the value {{v2_api_key}} in Postman.","name":"SF-API-KEY","in":"header","scopes":[],"schemeName":"SF-API-KEY"}}},"servers":{"deb55e91-7ce8-4a7c-a5f5-5101be18638b":{"url":"https://persephone.superform.xyz"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API key required for authentication. Use the value {{v2_api_key}} in Postman.","name":"SF-API-KEY","in":"header","scopes":[],"schemeName":"SF-API-KEY"},"schema":{"title":"SF-API-KEY","type":"string","description":"API key required for authentication. Use the value {{v2_api_key}} in Postman.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"SF-API-KEY","name":"SF-API-KEY"}],"title":"SF-API-KEY"}]},"originalFileLocation":"https://persephone.superform.xyz/openapi.json"},"subdomain":"superform-cb7ef652","siteName":"Superform","title":"Get Provider By Id - Superform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T00:38:57.839Z","originalFileLocation":"api-reference/restapiservice/get-provider-by-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider\u0026#x27;s eligible vaults.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Superform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Provider By Id - Superform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider\u0026#x27;s eligible vaults.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Superform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superform-cb7ef652.mintlify.app/_mintlify/api/og/v2?division=Reference\u0026amp;title=Get+Provider+By+Id\u0026amp;description=Returns+a+single+provider.+The+%7Bid%7D+path+param+accepts+a+provider+id%2C+a+vanity_url%2C+or+a+slugified+name%3B+the+BE+tries+each+in+turn.+404+when+the+slug+does+not+r\u0026amp;theme=18c32a119d8dd3192dd93b7c\u0026amp;signature=4f672217d5349988b5057cc5ee2af1627b434da3acf46a6d1e852c669b1a16b9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Provider By Id - Superform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider\u0026#x27;s eligible vaults.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superform-cb7ef652.mintlify.app/_mintlify/api/og/v2?division=Reference\u0026amp;title=Get+Provider+By+Id\u0026amp;description=Returns+a+single+provider.+The+%7Bid%7D+path+param+accepts+a+provider+id%2C+a+vanity_url%2C+or+a+slugified+name%3B+the+BE+tries+each+in+turn.+404+when+the+slug+does+not+r\u0026amp;theme=18c32a119d8dd3192dd93b7c\u0026amp;signature=4f672217d5349988b5057cc5ee2af1627b434da3acf46a6d1e852c669b1a16b9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/superform-cb7ef652/kAqp0EFgizYYfHtt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Superform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#254544\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/restapiservice/get-provider-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.superform.xyz/#organization\",\"name\":\"Superform\",\"url\":\"https://docs.superform.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superform-cb7ef652/OJBpJ8wuYZYVdHmI/logo/light.svg?fit=max\u0026auto=format\u0026n=OJBpJ8wuYZYVdHmI\u0026q=85\u0026s=61bbf5e05afb25fbcf7b210106c3ea0c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.superform.xyz#website\",\"name\":\"Superform\",\"url\":\"https://docs.superform.xyz\",\"publisher\":{\"@id\":\"https://docs.superform.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id#webpage\",\"url\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id\",\"name\":\"Get Provider By Id\",\"description\":\"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.\",\"dateModified\":\"2026-10-21T00:38:57.839Z\",\"isPartOf\":{\"@id\":\"https://docs.superform.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.superform.xyz/api-reference/restapiservice/get-supported-chains\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Provider By Id\",\"item\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id#apireference\",\"headline\":\"Get Provider By Id\",\"name\":\"Get Provider By Id\",\"description\":\"Returns a single provider. The {id} path param accepts a provider id, a vanity_url, or a slugified name; the BE tries each in turn. 404 when the slug does not resolve OR the provider is hidden/unapproved (the BE deliberately does not leak existence). Detail responses include pre-resolved chains and highest_apy_{day,week,month,year} computed across the provider's eligible vaults.\",\"url\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.superform.xyz/api-reference/restapiservice/get-provider-by-id#webpage\"},\"dateModified\":\"2026-10-21T00:38:57.839Z\",\"publisher\":{\"@id\":\"https://docs.superform.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.superform.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Superform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Superform","nav":{"global":{"anchors":[{"anchor":"Superform App","icon":"clapperboard-play","href":"https://app.superform.xyz"},{"anchor":"SuperformOS","icon":"gauge-high","href":"https://os.superform.xyz"},{"anchor":"GitHub","icon":"github","href":"https://github.com/superform-xyz"}]},"tabs":[{"tab":"Learn","pages":[{"title":"Learn","href":""}]},{"tab":"Build","pages":[{"title":"Build","href":"/build"}]},{"tab":"Operate","pages":[{"title":"Operate","href":"/operate"}]},{"tab":"Security","pages":[{"title":"Security","href":"/security"}]},{"tab":"Deployments","pages":[{"title":"Deployments","href":"/deployment-addresses"}]},{"tab":"API Reference","groups":[{"group":"SuperVaults","pages":[{"title":"Get All Supervaults","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/supervaults","href":"/api-reference/restapiservice/get-all-supervaults"},{"title":"Get Vault Details","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/vaults/{id}","href":"/api-reference/restapiservice/get-vault-details"},{"title":"Get Vault Historical Data","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/vaults/stats/historical/{ids}","href":"/api-reference/restapiservice/get-vault-historical-data"},{"title":"Get Vault Reward Rates","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/vaults/rewards","href":"/api-reference/restapiservice/get-vault-reward-rates"}]},{"group":"Balances","pages":[{"title":"Get User Balance","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/balances/{address}","href":"/api-reference/restapiservice/get-user-balance"}]},{"group":"Rewards","pages":[{"title":"Get user external claimable rewards","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/rewards/external/claimable/{user_address}","href":"/api-reference/rewards/get-user-external-claimable-rewards"},{"title":"Get reward opportunities","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/rewards/opportunities","href":"/api-reference/rewards/get-reward-opportunities"},{"title":"Get user rewards summary","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/rewards/summary/{user_address}","href":"/api-reference/rewards/get-user-rewards-summary"}]},{"group":"Tokens","pages":[{"title":"List Fungibles","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/fungibles","href":"/api-reference/fungibles/list-fungibles"},{"title":"Get Fungible Detail","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/fungibles/{fungible_id}","href":"/api-reference/fungibles/get-fungible-detail"},{"title":"Get Fungible Detail By Token","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/fungibles/by-token/{token_id}","href":"/api-reference/fungibles/get-fungible-detail-by-token"},{"title":"Get Fungible Price History","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/fungibles/{fungible_id}/history","href":"/api-reference/fungibles/get-fungible-price-history"}]},{"group":"Reference","pages":[{"title":"Get Supported Chains","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/supported/chains","href":"/api-reference/restapiservice/get-supported-chains"},{"title":"Get All Providers","description":"Lists providers. Filters: q (substring match on name/categories), category[], include_hidden (auth-gated). Sort: tvl_total | name | num_vaults (default tvl_total desc). Pass fields=summary to receive the slim ApiProviderListItem shape; otherwise the existing fat common.Provider shape is returned for back-compat.","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/providers","href":"/api-reference/restapiservice/get-all-providers"},{"title":"Get Provider By Id","deprecated":null,"version":null,"openapi":"https://persephone.superform.xyz/openapi.json get /v1/providers/{id}","href":"/api-reference/restapiservice/get-provider-by-id"}]}]}]},"title":"Get Provider By Id - Superform","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}