Welcome to NameShouts 2.0 Developer Documentation. The NameShouts API 2.0 lets your applications fetch data from the NameShouts database, access our audio files and access custom lists (with verified and recorded pronunciations).We also support cross-origin resource sharing. This allows you to interact securely with the API from a client-side web application.Based on simple REST principles, our Web API endpoints return metadata in JSON format.These API references are newly launched. We’ve put lots of effort into improving content and completeness to support this launch, but you might find areas that need more love. Please consider reaching out to us at contact@nameshouts.com if you have any feedback.Base Address of the API:
Rate Limits:The rate limits for name searches are 60 requests/minute and for higher tier requests it may be limited to 20 requests/minute. These limits may be increased if requested.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NameShouts Developer Documentation","description":"Access the NameShouts API to integrate accurate, multilingual name pronunciations into your applications. Explore endpoints, authentication, and integration guides.","colors":{"primary":"#1F8098","light":"#1ECAAB","dark":"#1ECAAB"},"logo":{"light":"https://mintcdn.com/name-shouts/BO0ybX9IXMcK0Ll6/images/nameshouts-api-docs-logo.png?fit=max\u0026auto=format\u0026n=BO0ybX9IXMcK0Ll6\u0026q=85\u0026s=088ab2fb27741bf0fcc6688dec23701f","dark":"https://mintcdn.com/name-shouts/BO0ybX9IXMcK0Ll6/images/nameshouts-api-docs-logo.png?fit=max\u0026auto=format\u0026n=BO0ybX9IXMcK0Ll6\u0026q=85\u0026s=088ab2fb27741bf0fcc6688dec23701f"},"favicon":{"light":"https://mintcdn.com/name-shouts/BO0ybX9IXMcK0Ll6/images/nameshouts-favicon.png?fit=max\u0026auto=format\u0026n=BO0ybX9IXMcK0Ll6\u0026q=85\u0026s=1b5261b5aae79868e66712ae6f7b59a9","dark":"https://mintcdn.com/name-shouts/BO0ybX9IXMcK0Ll6/images/nameshouts-favicon.png?fit=max\u0026auto=format\u0026n=BO0ybX9IXMcK0Ll6\u0026q=85\u0026s=1b5261b5aae79868e66712ae6f7b59a9"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.nameshouts.com/api/v2.0"}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#F3F7F9","dark":"#0F1B26"}},"navbar":{"links":[{"href":"https://help.nameshouts.com","label":"Help Center"},{"href":"mailto:contact@nameshouts.com","label":"Support"}],"primary":{"type":"button","label":"Sign Up","href":"https://app2.nameshouts.com/login"}},"footer":{"socials":{"website":"https://www.nameshouts.com","linkedin":"https://www.linkedin.com/company/nameshouts","x":"https://x.com/NameShouts","facebook":"https://facebook.com/nameshouts"},"links":[{"header":"NameShouts","items":[{"label":"Help Center","href":"https://help.nameshouts.com"},{"label":"nameshouts.com","href":"https://www.nameshouts.com"},{"label":"Contact us","href":"mailto:contact@nameshouts.com"}]}]},"seo":{"metatags":{"og:image":"https://name-shouts.mintlify.site/images/og-image.png","og:image:width":"1200","og:image:height":"630","og:image:alt":"NameShouts API Docs: bring name pronunciation into your app","twitter:image":"https://name-shouts.mintlify.site/images/og-image.png"}},"fonts":{"family":"DM Sans"},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"background":"https://mintcdn.com/name-shouts/Bxz8ov7WAfmrud7F/images/og-image.png?fit=max\u0026auto=format\u0026n=Bxz8ov7WAfmrud7F\u0026q=85\u0026s=8e9f53f5a931784ac98f0c4a0a9ef715"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"name-shouts","hasAudioNarration":false,"actualSubdomain":"name-shouts","customDomains":["docs.nameshouts.com"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-name-shouts-79cc1247","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adbc36f6d07b13661cd9ff8","collectionId":"675f43cd-eb6a-49ae-959f-ba8657822d34","liveDeploymentHistoryId":"6adbc36f6d07b13661cd9ff8","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbc3f845c9cef2594f9b29","clientVersion":"0.0.3952","searchFilterCounts":[{"language":"default","tag":"Lists","count":9},{"language":"default","tag":"Names","count":6},{"language":"default","tag":"Authenticating Requests","count":2},{"language":"default","tag":"Language","count":2},{"language":"default","tag":"Additional guides","count":2},{"language":"default","tag":"Getting started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--ns-navy:#21456B;--ns-teal:#1F8098;--ns-mint:#1ECAAB;--ns-mint2:#3FC6A6;--ns-tint:#F3F7F9;--ns-text:#333333;--ns-muted:#5B6B78;--ns-line:rgba(33, 69, 107, .12);--ns-grad:linear-gradient(90deg, #1F8098 0%, #3FC6A6 100%);--ns-shadow:0 10px 30px rgba(33, 69, 107, .08);--ns-shadow-hover:0 16px 40px rgba(31, 128, 152, .18)}body{color:var(--ns-text);-webkit-font-smoothing:antialiased}::selection{background:rgba(30,202,171,.3)}#navbar{box-shadow:0 1px 0 var(--ns-line),0 6px 24px rgba(33,69,107,.05)}#navbar::after{content:\"\";position:absolute;left:0;right:0;bottom:-3px;height:3px;background:var(--ns-grad);pointer-events:none}#navbar,#navbar [class*=backdrop-blur],#navbar>div{background:#fff!important}#navbar img{max-height:35px;height:35px;width:auto}#navbar a:not(#topbar-cta-button a){color:var(--ns-text);font-weight:500}#navbar a:not(#topbar-cta-button a):hover{color:var(--ns-teal)}#topbar-cta-button a{background:var(--ns-mint)!important;color:#fff!important;border-radius:12px!important;font-weight:500;padding-left:18px;padding-right:18px;box-shadow:0 6px 16px rgba(30,202,171,.35)}#topbar-cta-button a:hover{background:#17b597!important}#topbar-cta-button a *{color:#fff!important}#search-bar-entry{border-radius:12px!important;border:1px solid var(--ns-line)!important;background:#fff!important;box-shadow:none!important}#search-bar-entry:hover{border-color:var(--ns-mint)!important}.sidebar-group-header,.sidebar-group-header *{color:var(--ns-navy)!important}.sidebar-group-header{font-weight:700;font-size:12px;text-transform:uppercase;letter-spacing:.6px}#sidebar li a{color:var(--ns-text);font-weight:500;border-radius:10px!important}#sidebar li a:hover{background:rgba(31,128,152,.08)!important;color:var(--ns-teal)!important}#sidebar li[data-active=true]>a,#sidebar li[data-active=true]>div>a{background:rgba(30,202,171,.14)!important;color:var(--ns-teal)!important;box-shadow:inset 3px 0 0 var(--ns-mint);text-shadow:none!important;font-weight:600}#content-area{background:#fff;border:1px solid var(--ns-line);border-radius:18px;box-shadow:var(--ns-shadow);margin-top:28px;margin-bottom:40px;padding-top:40px;padding-right:48px;padding-bottom:8px}@media (min-width:1024px){#content-area{padding-left:40px!important;padding-right:40px;margin-left:0!important}}.tryit-button{background:var(--ns-mint)!important;color:#fff!important;border-radius:11px!important;box-shadow:0 8px 18px rgba(30,202,171,.3);opacity:1!important}.tryit-button:hover{background:#19b89b!important}@media (max-width:1023px){#content-area{padding:26px 22px 8px;border-radius:14px;margin-top:16px}}#header .eyebrow{color:var(--ns-teal)!important;font-weight:600;letter-spacing:.3px}#page-title{font-weight:700!important;font-size:34px;letter-spacing:-.4px;line-height:1.25;text-decoration-line:underline;text-decoration-color:rgba(30,202,171,.26);text-decoration-thickness:.4em;text-underline-offset:-.22em;text-decoration-skip-ink:none}#header .description,#header p{color:var(--ns-muted)}.mdx-content{color:var(--ns-text)}.mdx-content li,.mdx-content p{color:var(--ns-text);font-size:17px;line-height:1.7}.mdx-content h2{font-weight:700!important;letter-spacing:-.3px;margin-top:32px}.mdx-content h3,.mdx-content h4{color:var(--ns-teal)!important;font-weight:700!important}#page-title,.mdx-content h2,.mdx-content h4{color:var(--ns-navy)!important}.mdx-content strong{color:inherit}.mdx-content a:not(.card):not([class*=card]){color:var(--ns-teal)!important;text-decoration:none!important;border-bottom:1px solid rgba(31,128,152,.35)!important;font-weight:500}.mdx-content a:not(.card):not([class*=card]):hover{color:var(--ns-mint)!important;border-bottom-color:var(--ns-mint)!important}.mdx-content img{border:1px solid var(--ns-line);box-shadow:var(--ns-shadow)}.mdx-content blockquote{background:rgba(30,202,171,.08);border-left:4px solid var(--ns-mint);border-radius:0 12px 12px 0;padding:14px 18px;color:var(--ns-text)}.mdx-content img,.mdx-content table{border-radius:14px}.mdx-content table th,.mdx-content thead th{color:var(--ns-navy)!important;font-weight:700}.mdx-content td,.mdx-content th{border-color:var(--ns-line)!important}.callout{border-radius:0 12px 12px 0!important;border-width:0 0 0 4px!important}.callout[data-callout-type=check],.callout[data-callout-type=info],.callout[data-callout-type=note],.callout[data-callout-type=tip]{background:rgba(30,202,171,.08)!important;border-left-color:var(--ns-mint)!important}.callout[data-callout-type=check] *,.callout[data-callout-type=info] *,.callout[data-callout-type=note] *,.callout[data-callout-type=tip] *{color:var(--ns-text)!important}.callout[data-callout-type=check] svg,.callout[data-callout-type=info] svg,.callout[data-callout-type=note] svg,.callout[data-callout-type=tip] svg{color:var(--ns-teal)!important;fill:var(--ns-teal)!important}.callout[data-callout-type=danger],.callout[data-callout-type=warning]{border-left-color:#e5a100!important}.mdx-content :not(pre)>code{color:var(--ns-teal);background:rgba(31,128,152,.08);border-radius:6px;padding:1px 6px}.code-block{border-radius:14px!important}#footer,.code-block,.field{border-color:var(--ns-line)!important}.card,.mdx-content a.ns-tile-card{border:1px solid var(--ns-line)!important}.card{position:relative;overflow:hidden;background:#fff!important;border-radius:18px!important;box-shadow:var(--ns-shadow)!important;transition:transform .2s,box-shadow .2s,border-color .2s}.card::before{content:\"\";position:absolute;left:0;right:0;top:0;height:4px;background:var(--ns-grad);opacity:.9;z-index:1}.card:hover{transform:translateY(-4px);box-shadow:var(--ns-shadow-hover)!important;border-color:rgba(30,202,171,.55)!important}.card [data-component-part=card-title],.card h2{color:var(--ns-navy)!important;font-weight:700!important}[data-component-part=card-icon] svg{background:linear-gradient(135deg,#1f8098,#3fc6a6)!important}.ns-grid{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:20px;margin:4px 0 8px}.ns-grid-3{grid-template-columns:repeat(3,minmax(0,1fr))}@container (max-width: 620px){.ns-grid-3{grid-template-columns:1fr}}@container (max-width: 520px){.ns-grid{grid-template-columns:1fr}}.mdx-content a.ns-tile-card{display:flex;flex-direction:column;background:#fff;border-radius:16px;padding:28px 28px 24px;color:var(--ns-text)!important;text-decoration:none!important;font-weight:400;transition:border-color .2s,box-shadow .2s,transform .2s}.mdx-content a.ns-tile-card:hover{border-color:rgba(30,202,171,.55)!important;box-shadow:var(--ns-shadow-hover);transform:translateY(-2px)}.ns-tile-head{display:flex;align-items:center;gap:12px;margin-bottom:18px}.ns-chip{width:40px;height:40px;flex:none;border-radius:12px;display:inline-flex;align-items:center;justify-content:center;background:linear-gradient(to right,rgba(31,128,152,.1),rgba(63,198,166,.14));border:1px solid rgba(31,128,152,.16)}.ns-chip svg{width:20px!important;height:20px!important;margin:0!important;background:var(--ns-teal)!important}.ns-label{font-size:13px;font-weight:600;letter-spacing:1.1px;text-transform:uppercase;color:var(--ns-navy)}.mdx-content .ns-tile-card p.ns-tile-title{font-size:21px;font-weight:700;line-height:1.3;letter-spacing:-.2px;color:var(--ns-navy)!important;margin:0 0 8px}.mdx-content .ns-tile-card p.ns-tile-desc{font-size:16px;line-height:1.6;color:var(--ns-muted)!important;margin:0 0 22px;flex:1}.ns-tile-link{margin-top:auto;font-size:15px;font-weight:600;color:var(--ns-teal);transition:color .2s}.mdx-content a.ns-tile-card:hover .ns-tile-link{color:#17a88e}.mdx-content .ns-grid-3 a.ns-tile-card{padding:24px 22px 20px}.mdx-content .ns-grid-3 .ns-tile-card p.ns-tile-title{font-size:18px}.mdx-content p.ns-section-title{font-size:24px;font-weight:700;letter-spacing:-.3px;color:var(--ns-navy)!important;margin:44px 0 4px}.mdx-content p.ns-section-sub{font-size:16px;color:var(--ns-muted)!important;margin:0 0 20px}#footer{color:var(--ns-muted);font-size:13px}#footer a,#pagination a:hover{color:var(--ns-teal)!important}"}],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction to the API","sidebarTitle":"Introduction to the API","description":"NameShouts 2.0 Developer","href":"/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"NameShouts 2.0 Developer\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`welcome`,children:_jsx(_components.strong,{children:`Welcome`})}),`\n`,_jsx(_components.p,{children:`Welcome to NameShouts 2.0 Developer Documentation. The NameShouts API 2.0 lets your applications fetch data from the NameShouts database, access our audio files and access custom lists (with verified and recorded pronunciations).`}),`\n`,_jsxs(_components.p,{children:[`We also support `,_jsx(_components.a,{href:`https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS`,children:`cross-origin`}),` resource sharing. This allows you to interact securely with the API from a client-side web application.`]}),`\n`,_jsxs(_components.p,{children:[`Based on simple `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Representational_state_transfer`,children:`REST`}),` principles, our Web API endpoints return metadata in `,_jsx(_components.a,{href:`http://www.json.org/`,children:`JSON`}),` format.`]}),`\n`,_jsxs(_components.p,{children:[`These API references are newly launched. We’ve put lots of effort into improving content and completeness to support this launch, but you might find areas that need more love. Please consider reaching out to us at `,_jsx(_components.a,{href:`mailto:contact@nameshouts.com`,children:`contact@nameshouts.com`}),` if you have any feedback.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Base Address of the API:`})}),`\n`,_jsx(Heading,{level:`4`,id:`https//api-nameshouts-com/api/v2-0/`,children:_jsx(_components.a,{href:`https://api.nameshouts.com/api/v2.0/`,children:_jsx(_components.code,{children:`https://api.nameshouts.com/api/v2.0/`})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Rate Limits:`})}),`\n`,_jsxs(_components.p,{children:[`The rate limits for name searches are `,_jsx(_components.strong,{children:`60 requests/minute`}),` and for higher tier requests it may be limited to `,_jsx(_components.strong,{children:`20 requests/minute`}),`. These limits may be increased if requested.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Introduction to the API","sidebarTitle":"Introduction to the API","description":"NameShouts 2.0 Developer","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":3,"children":[]},{"title":"https://api.nameshouts.com/api/v2.0/","slug":"https//api-nameshouts-com/api/v2-0/","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"name-shouts","siteName":"NameShouts Developer Documentation","title":"Introduction to the API - NameShouts Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T16:02:39.754Z","originalFileLocation":"introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"NameShouts 2.0 Developer\">\u003cmeta data-mint-head name=\"application-name\" content=\"NameShouts Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_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/name-shouts/MYMwX_H8OSkdcXtR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction to the API - NameShouts Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"NameShouts 2.0 Developer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NameShouts Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nameshouts.com/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://name-shouts.mintlify.site/images/og-image.png\">\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=\"Introduction to the API - NameShouts Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"NameShouts 2.0 Developer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://name-shouts.mintlify.site/images/og-image.png\">\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/name-shouts/MYMwX_H8OSkdcXtR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NameShouts Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F8098\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"NameShouts API Docs: bring name pronunciation into your app\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nameshouts.com/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nameshouts.com/#organization\",\"name\":\"NameShouts Developer Documentation\",\"url\":\"https://docs.nameshouts.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/name-shouts/BO0ybX9IXMcK0Ll6/images/nameshouts-api-docs-logo.png?fit=max\u0026auto=format\u0026n=BO0ybX9IXMcK0Ll6\u0026q=85\u0026s=088ab2fb27741bf0fcc6688dec23701f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nameshouts.com#website\",\"name\":\"NameShouts Developer Documentation\",\"url\":\"https://docs.nameshouts.com\",\"publisher\":{\"@id\":\"https://docs.nameshouts.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nameshouts.com/introduction#webpage\",\"url\":\"https://docs.nameshouts.com/introduction\",\"name\":\"Introduction to the API\",\"description\":\"NameShouts 2.0 Developer\",\"dateModified\":\"2026-10-21T16:02:39.754Z\",\"isPartOf\":{\"@id\":\"https://docs.nameshouts.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nameshouts.com/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nameshouts.com/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting started\",\"item\":\"https://docs.nameshouts.com/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction to the API\",\"item\":\"https://docs.nameshouts.com/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.nameshouts.com/introduction#article\",\"headline\":\"Introduction to the API\",\"name\":\"Introduction to the API\",\"description\":\"NameShouts 2.0 Developer\",\"url\":\"https://docs.nameshouts.com/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nameshouts.com/introduction#webpage\"},\"image\":\"https://name-shouts.mintlify.site/images/og-image.png\",\"dateModified\":\"2026-10-21T16:02:39.754Z\",\"publisher\":{\"@id\":\"https://docs.nameshouts.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nameshouts.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NameShouts Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NameShouts Developer Documentation","nav":{"global":null,"groups":[{"group":"Getting started","pages":[{"title":"Build with NameShouts","sidebarTitle":"Overview","description":"Explore our documentation to bring accurate name pronunciation into your app.","mode":"wide","href":"/index"},{"title":"Introduction to the API","sidebarTitle":"Introduction to the API","href":"/introduction"}]},{"group":"Authenticating Requests","pages":[{"title":"Authenticating Requests","sidebarTitle":"Overview","description":null,"href":"/authentication"},{"title":"Get language info with Access Token","api":"GET /lang","href":"/api-reference/authentication/get-language-info-with-access-token"}]},{"group":"Language","pages":[{"title":"Language","sidebarTitle":"Overview","href":"/api-reference/languages/overview"},{"title":"Get All Visible Languages","api":"GET /lang","href":"/api-reference/languages/get-all-languages"}]},{"group":"Names","pages":[{"title":"Names","sidebarTitle":"Overview","href":"/api-reference/names/overview"},{"title":"Get Name with Language","api":"GET /name/{name}/{language}","href":"/api-reference/names/get-name-in-a-language"},{"title":"Get Multiple Names with Language","api":"GET /name/{names}/{language}","href":"/api-reference/names/get-multiple-names-with-language"},{"title":"Get Name without language","api":"GET /name/{name}","href":"/api-reference/names/get-name-in-all-languages"},{"title":"Get Multiple Names without Language","api":"GET /name/{names}","href":"/api-reference/names/get-multiple-names-without-language"},{"title":"Request a missing name/names","api":"POST /user/request-name","href":"/api-reference/names/request-a-missing-name"}]},{"group":"Lists","pages":[{"title":"Lists","sidebarTitle":"Overview","href":"/lists"},{"title":"Get all lists that is owned by user","api":"GET /user/user-lists","href":"/api-reference/lists/get-lists-owned-by-user"},{"title":"Get All Names from List","api":"GET /user/user-list","href":"/api-reference/lists/get-all-names-from-a-list"},{"title":"Get All User Lists","api":"GET /user/get-all-user-lists","href":"/api-reference/lists/get-all-user-lists"},{"title":"Get Name information from List.","api":"GET /user/user-list/get-name-group-from-user-list","href":"/api-reference/lists/get-name-from-a-list"},{"title":"Add Name to a User List","api":"POST /user/user-list/add-name-to-list","href":"/api-reference/lists/add-name-to-a-list"},{"title":"Update Name from a User List","api":"POST /user/user-list/edit-name","href":"/api-reference/lists/update-name-on-a-list"},{"title":"Remove Name from List","api":"POST /user/user-list/remove-name-from-list","href":"/api-reference/lists/remove-name-from-a-list"},{"title":"Get Public Link for name","api":"GET /user/user-list/get-signature-link","href":"/api-reference/lists/get-public-link-for-a-name"}]},{"group":"Additional guides","pages":[{"title":"Rate limits","href":"/rate-limits"},{"title":"Audio files","href":"/audio-files"}]}]},"title":"Introduction to the API - NameShouts Developer Documentation","buildId":"dpl_7GUK3ixdQTF3BSNUQYJm8ibGxQWw","deploymentId":"dpl_7GUK3ixdQTF3BSNUQYJm8ibGxQWw","dynamics":[],"chunks":[]}
