Log in to your SportXAPI Dashboard to retrieve your secret production API key. If you need custom quotas or a commercial plan, you can request an API key via our contact form.
Demo previews in the interactive API reference are rate-limited and do not expose your production credentials.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SportXAPI","description":"SportXAPI Cricket API Documentation \u0026 Interactive Reference","colors":{"primary":"#f76121","light":"#ff7b42","dark":"#d94b0d"},"logo":{"light":"https://mintcdn.com/sportxapi-d8f45e8a/zbKwy5OZoPUFcS1j/assets/sxa-logo.png?fit=max\u0026auto=format\u0026n=zbKwy5OZoPUFcS1j\u0026q=85\u0026s=b184a2403dccb576539e559efa2abf58","dark":"https://mintcdn.com/sportxapi-d8f45e8a/zbKwy5OZoPUFcS1j/assets/sxa-logo.png?fit=max\u0026auto=format\u0026n=zbKwy5OZoPUFcS1j\u0026q=85\u0026s=b184a2403dccb576539e559efa2abf58","href":"https://sportxapi.com"},"favicon":"https://mintcdn.com/sportxapi-d8f45e8a/zbKwy5OZoPUFcS1j/assets/sxa-favicon.png?fit=max\u0026auto=format\u0026n=zbKwy5OZoPUFcS1j\u0026q=85\u0026s=933c50be5c4e17c2986965251cac354a","api":{"playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FAFAFA","dark":"#080808"}},"navbar":{"primary":{"type":"button","label":"Get API Key","href":"https://sportxapi.com/contact?intent=api-key"}},"footer":{"socials":{"website":"https://sportxapi.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sportxapi-d8f45e8a","hasAudioNarration":false,"actualSubdomain":"sportxapi-d8f45e8a","customDomains":["docsv2.sportxapi.com"],"gitSource":{"type":"artifacts","owner":"prod","repo":"ed902ec7d47ac04defbce701","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6af1f2878c4f16130c58502e"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1f2c127094b070708f6b3","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":54},{"language":"default","tag":"Live Matches \u0026 Ball-by-Ball","count":20},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Series \u0026 Tournaments","count":9},{"language":"default","tag":"Teams \u0026 Venues","count":8},{"language":"default","tag":"Rankings","count":7},{"language":"default","tag":"Getting Started","count":5},{"language":"default","tag":"Resources","count":3},{"language":"default","tag":"News \u0026 Shorts","count":3},{"language":"default","tag":"Players","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--brand-orange: #f76121;--brand-orange-light: #ff7b42;--brand-orange-hover: #e04f10;--brand-dark: #080808}header a:has(img.nav-logo),#navbar a:has(img.nav-logo){display:flex!important;align-items:center!important;visibility:visible!important;opacity:1!important}header img.nav-logo,#navbar img.nav-logo{max-height:28px!important;height:28px!important;width:auto!important;object-fit:contain!important}#topbar-cta-button{display:flex!important;align-items:center!important}#topbar-cta-button a{background:transparent!important;border:none!important;box-shadow:none!important;border-radius:9999px!important;padding:0!important;position:relative!important;display:inline-flex!important;align-items:center!important}#topbar-cta-button a span.absolute{background:var(--brand-orange)!important;border-radius:9999px!important;box-shadow:none!important;filter:none!important;transition:background-color 0.15s ease!important}#topbar-cta-button a:hover span.absolute{background:var(--brand-orange-hover)!important;box-shadow:none!important;filter:none!important}#topbar-cta-button a>div{padding:8px 18px!important;display:flex!important;align-items:center!important;gap:6px!important}#topbar-cta-button a>div span{color:#ffffff!important;font-weight:600!important;letter-spacing:-0.01em!important}button[type=\"button\"].bg-primary,button[type=\"button\"].bg-primary-dark,button.rounded-full,a.rounded-full{border-radius:9999px!important;box-shadow:none!important;filter:none!important}[data-active=\"true\"]{color:var(--brand-orange)!important;text-shadow:none!important;box-shadow:none!important;filter:none!important}::selection{background:rgba(247, 97, 33, 0.3)!important}#topbar-cta-button a span,#topbar-cta-button a:hover span,.sxa-toc-dot,.sxa-toc-item,[data-active=\"true\"],.text-primary,.bg-primary{box-shadow:none!important;text-shadow:none!important;filter:none!important}.sxa-left-toc-container{margin-top:0.5rem;margin-bottom:0.5rem;margin-left:0.85rem;padding-left:0.75rem;border-left:1.5px solid rgba(247, 97, 33, 0.35);animation:sxaFadeIn 0.2s cubic-bezier(0.16, 1, 0.3, 1);display:block!important}@keyframes sxaFadeIn{from{opacity:0;transform:translateY(-2px)}to{opacity:1;transform:translateY(0)}}.sxa-left-toc-title{display:flex;align-items:center;gap:0.375rem;font-size:0.65rem;font-weight:700;text-transform:uppercase;letter-spacing:0.05em;color:#f76121;margin-bottom:0.375rem;user-select:none}.sxa-toc-item{display:flex!important;align-items:center!important;gap:0.4rem!important;font-size:0.75rem!important;line-height:1.35rem!important;padding:2px 0!important;color:#a1a1aa!important;text-decoration:none!important;transition:all 0.15s ease!important;box-shadow:none!important;text-shadow:none!important}.sxa-toc-item:hover{color:#ff7b42!important;transform:translateX(2px)}.sxa-toc-item.active{color:#f76121!important;font-weight:600!important}.sxa-toc-dot{width:5px;height:5px;border-radius:9999px;background-color:#f76121;box-shadow:none!important;filter:none!important;flex-shrink:0}.scroll-mt-\\(--scroll-mt\\){max-width:1680px!important;padding-left:1.5rem!important;padding-right:1.5rem!important}#content-area{padding-left:0.25rem!important;margin-left:0!important;max-width:none!important}#content-container>div.flex-row-reverse{gap:1.5rem!important}.xl\\:w-\\[28rem\\]{width:24.5rem!important;flex-shrink:0!important}[data-component-part=\"scroll-area-viewport\"]{overflow-x:visible!important;mask-image:none!important;-webkit-mask-image:none!important;--scroll-area-overflow-x-end: 0px !important}[data-component-part=\"scroll-area-scrollbar\"]{display:none!important}[data-component-part=\"scroll-area-content\"] select,select[aria-label=\"Select base URL\"]{width:155px!important;font-size:12px!important}[data-component-part=\"scroll-area-content\"] .font-mono{font-size:13px!important}"}],"page":{"pagePath":"getting-started","slug":"/getting-started","pageMetadata":{"title":"Getting Started","description":"Start querying live cricket data with SportXAPI in minutes.","href":"/getting-started"},"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: \"Start querying live cricket data with SportXAPI in minutes.\"\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`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Every request starts with your API key. Keep your API key secure on your server and call SportXAPI from backend code whenever possible.`}),`\n`,_jsx(Heading,{level:`2`,id:`1-get-your-api-key`,children:`1. Get Your API Key`}),`\n`,_jsxs(_components.p,{children:[`Log in to your `,_jsx(_components.a,{href:`https://dashboard.sportxapi.com/`,children:`SportXAPI Dashboard`}),` to retrieve your secret production API key. If you need custom quotas or a commercial plan, you can request an API key via our `,_jsx(_components.a,{href:`https://sportxapi.com/contact?intent=api-key`,children:`contact form`}),`.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`2-choose-your-environment`,children:`2. Choose Your Environment`}),`\n`,_jsx(_components.p,{children:`Select the environment that fits your current stage of development:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Paid plans:`}),` Point your requests to `,_jsx(_components.code,{children:`https://apiv2.sportxapi.com`}),` with your production key.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Free / demo testing:`}),` Point your requests to `,_jsx(_components.code,{children:`https://api.sportxapi.com`}),` (capped at 100 requests per month).`]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`3-make-your-first-request`,children:`3. Make Your First Request`}),`\n`,_jsxs(_components.p,{children:[`Pass your API key in the `,_jsx(_components.code,{children:`X-API-Key`}),` request header. Here is an example fetching the live match schedule:`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key: YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://apiv2.sportxapi.com/cricket/api/v2/match/schedule?status=live`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js`,numberOfLines:`8`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://apiv2.sportxapi.com/cricket/api/v2/match/schedule?status=live\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` process`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`env`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:`SPORTXAPI_KEY`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Accept\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"application/json\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` data`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`data`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`11`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`11`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://apiv2.sportxapi.com/cricket/api/v2/match/schedule?status=live\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-API-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SPORTXAPI_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`),`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Accept\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(response.json())`})]}),`\n`]})})})]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Demo previews in the interactive API reference are rate-limited and do not expose your production credentials.`})})]})}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":{"config":{},"pageMetadata":{"title":"Getting Started","description":"Start querying live cricket data with SportXAPI in minutes.","href":"/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"1. Get Your API Key","slug":"1-get-your-api-key","depth":2,"children":[]},{"title":"2. Choose Your Environment","slug":"2-choose-your-environment","depth":2,"children":[]},{"title":"3. Make Your First Request","slug":"3-make-your-first-request","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sportxapi-d8f45e8a/f5c07d36ae9c207d/custom.js"],"subdomain":"sportxapi-d8f45e8a","siteName":"SportXAPI","title":"Getting Started - SportXAPI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T16:20:46.919Z","originalFileLocation":"getting-started.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=\"dark\"}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=\"Start querying live cricket data with SportXAPI in minutes.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SportXAPI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started - SportXAPI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start querying live cricket data with SportXAPI in minutes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SportXAPI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docsv2.sportxapi.com/getting-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sportxapi-d8f45e8a.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Getting+Started\u0026amp;description=Start+querying+live+cricket+data+with+SportXAPI+in+minutes.\u0026amp;theme=c7f68d35fc5d18bb1505582a\u0026amp;signature=d631fcd37b1e11463495eb54d82739ced5898d6e71431da9e99f57102b168c66\">\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=\"Getting Started - SportXAPI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start querying live cricket data with SportXAPI in minutes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sportxapi-d8f45e8a.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Getting+Started\u0026amp;description=Start+querying+live+cricket+data+with+SportXAPI+in+minutes.\u0026amp;theme=c7f68d35fc5d18bb1505582a\u0026amp;signature=d631fcd37b1e11463495eb54d82739ced5898d6e71431da9e99f57102b168c66\">\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/sportxapi-d8f45e8a/SKViBGuORTDMzrHv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SportXAPI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f76121\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docsv2.sportxapi.com/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docsv2.sportxapi.com/#organization\",\"name\":\"SportXAPI\",\"url\":\"https://docsv2.sportxapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sportxapi-d8f45e8a/zbKwy5OZoPUFcS1j/assets/sxa-logo.png?fit=max\u0026auto=format\u0026n=zbKwy5OZoPUFcS1j\u0026q=85\u0026s=b184a2403dccb576539e559efa2abf58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docsv2.sportxapi.com#website\",\"name\":\"SportXAPI\",\"url\":\"https://docsv2.sportxapi.com\",\"publisher\":{\"@id\":\"https://docsv2.sportxapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docsv2.sportxapi.com/getting-started#webpage\",\"url\":\"https://docsv2.sportxapi.com/getting-started\",\"name\":\"Getting Started\",\"description\":\"Start querying live cricket data with SportXAPI in minutes.\",\"dateModified\":\"2026-11-09T16:20:46.919Z\",\"isPartOf\":{\"@id\":\"https://docsv2.sportxapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docsv2.sportxapi.com/getting-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docsv2.sportxapi.com/getting-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://docsv2.sportxapi.com/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started\",\"item\":\"https://docsv2.sportxapi.com/getting-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docsv2.sportxapi.com/getting-started#article\",\"headline\":\"Getting Started\",\"name\":\"Getting Started\",\"description\":\"Start querying live cricket data with SportXAPI in minutes.\",\"url\":\"https://docsv2.sportxapi.com/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://docsv2.sportxapi.com/getting-started#webpage\"},\"dateModified\":\"2026-11-09T16:20:46.919Z\",\"publisher\":{\"@id\":\"https://docsv2.sportxapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docsv2.sportxapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SportXAPI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SportXAPI","nav":{"global":null,"tabs":[{"tab":"Guides","groups":[{"group":"Getting Started","pages":[{"title":"SportXAPI Cricket Data API","sidebarTitle":"Introduction","description":"High-performance, low-latency cricket data API for live scoreboards, ball-by-ball commentary, match statistics, schedules, series, squads, players, and rankings.","href":""},{"title":"Getting Started","href":"/getting-started"},{"title":"Authentication","description":"How to authenticate requests to the SportXAPI Cricket API.","href":"/authentication"},{"title":"Rate Limits \u0026 Plans","href":"/rate-limits"},{"title":"Errors \u0026 Status Codes","href":"/errors"}]},{"group":"API Overview","pages":[{"title":"API Reference Overview","sidebarTitle":"API Overview","href":"/api-reference"}]},{"group":"Resources","pages":[{"title":"SDKs \u0026 Code Examples","href":"/sdks"},{"title":"Webhooks","href":"/webhooks"},{"title":"Changelog","href":"/changelog"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/live-matches-\u0026-ball-by-ball/featured-matches"}]}]},"basePath":"","title":"Getting Started - SportXAPI","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}