{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"264252ed-8cdd-4d7b-973d-5b639a466a68","name":"SportsCapital API","description":"The SportsCapital API allows you to search real-time player news and injury data based on their content, mentioned entities and publish date.\n\nThe API is structured around five main components:\n\n- [Reference Endpoints](#71b0f9d5-612e-4eab-af06-3b74b8039480) that provide valid filtering options\n    \n- [Entity Endpoints](#06ae4c61-3085-4a9f-9a13-a064b7a3d10a) that provide information to filter on specific entities\n    \n- [Search Endpoints](#0da716e9-e4c9-4cf7-afe7-7522ff374ce1) that allow you to save Searches with specific filtering criteria to automatically identify relevant incoming Snippets, and link this fully enriched data to downstream Integrations.\n    \n- [Integration Endpoints](#3b4a46fe-71ae-46c7-9c49-ef07766446f4) that allow you to connect to destination systems (like Slack or AWS S3) where matching Snippets will be automatically delivered in real-time if they match a linked Search.\n    \n- [Query Snippet Endpoint](#1f3980f5-2a02-4b2a-9158-7a8892d94f51) that allows you to search for historical Snippets on demand.\n    \n\nThe API is organized by **League**, with each [Snippet, Entity, Search, Integration](https://docs.sportscapital.io/pages/glossary.html) belonging to a specific sports league (NHL, NBA, MLB, etc.).\n\nThis API Reference will provide information on the endpoints available with example requests and responses. It will link to the [User Documents](https://docs.sportscapital.io) frequently, which will include more about our Recommended Workflows, Data Operations and Glossary & Terminology.\n\n# API Access\n\nYou will need an API Key to use the SportsCapital API. There are two (2) ways to get an API Key.\n\n## Free Tier\n\nYou can start testing now by [signing up for a free account](https://account.sportscapital.io/sign-up) and validating your email. Once you validate your email, you will navigate to your [Command Center](https://account.sportscapital.io/api) to get access to a Free Test key. This test key is not meant for commercial or enterprise workloads. The free tier rate limits are shown in the table below:\n\n| Snippets Per Request | Snippets Per Day | Snippets Per Month |\n| --- | --- | --- |\n| 50 | 5000 | 10000 |\n\n## Enterprise Tier\n\nIf you have an Use Case in mind and the above rate-limits are too restricting to test out the API, please use the following link to schedule an introduction call, where we can provision you a Enterprise Trial key that meets your needs: [Setup API Introduction Call](https://calendly.com/ariccio-sportscapital/support)\n\n## League Access\n\nWhen you signup for a **Free Tier API Key**, you will only be allowed to select access to one league (currently we support NHL, NBA, MLB). If you signup for an **Enterprise Tier API Key**, you will be able to select 1 or more leagues during the Signup Process. Either way, you will be able to see which Leagues you have access to in your [Command Center](https://account.sportscapital.io/account).\n\n**Important Note: If you attempt to use an endpoint by specifying a league that you DO NOT have access to, you will get an 401 Unauthorized code which is detailed below.**\n\n# API Calls\n\nSportsCapital API is a [REST API](http://en.wikipedia.org/wiki/Representational_State_Transfer), uses standard [HTTP response codes, and verbs](https://developers.evrythng.com/docs/http-verbs-and-error-codes).\n\nAll endpoints **always** accept JSON in request bodies and return JSON responses. You will need to send the `content-type: application/json` header in **POST** requests.\n\nAll request and responses that accept or return timestamps (e.g. publish_date) **will be in UTC**\n\n## API Base URL\n\n## **`https://api.sportscapital.io`**\n\n## Authorization\n\nFor endpoints that require Authorization, this will be handled by adding your SportsCapital API key to your requests as a query parameter. All endpoints except the [Get Leagues Endpoint](#5190265f-e042-41bb-a03f-f912fdfe5a3c) and [Get Entity Types Endpoint](#6bd23fbf-c572-45c4-9e7c-91daaecd2938) require you to supply your API Key.\n\nFree Tier has permissions to use all endpoints **EXCEPT** [Integration Endpoints](#3b4a46fe-71ae-46c7-9c49-ef07766446f4). You will need to [set up an introduction call](https://calendly.com/ariccio-sportscapital/support) to request Integrations access, which will be required to set up automated real-time delivery of matching Snippets to your preferred destination systems.\n\n**NOTE: The examples below will not show the api_key in the requests to hide the API Key used for the interactive docs. It is implied that the first query parameter after the endpoint is the api key.**\n\n**NHL Teams Endpoint Example:**\n\n**`https://api.sportscapital.io/athena/v1/teams?api_key={API_Key}&league_id={NHL_League_ID}`**\n\n## Response Codes\n\nThe table below describes the most common response codes that you will receive from a request. In addition to the status code, most responses will receive a body with a JSON structure that represents the results of a successful request or additional error information.\n\n| **Status Code** | **Endpoint(s)** | **Description** |\n| --- | --- | --- |\n| 200 Ok | All | Request as successful and you should expect a json response |\n| 400 Bad Request | All but League Endpoint | Request is invalid, normally because of an invalid league tricode as a query parameter |\n| 401 Unauthorized | All but League Endpoint | API Key is unauthorized to make the Request, usually because user does not have access to the league in the query parameter |\n| 403 Forbidden | Any Endpoint that requires an API Key | No API Key is supplied as a query parameter or the API Key is not active and needs email validation |\n| 404 Not Found | Delete or Unlink Endpoints | Search Id or Integration Id is not found, or they are not linked |\n| 409 Conflict | Search Integration Link | Link already exists |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31769575","team":5895315,"collectionId":"264252ed-8cdd-4d7b-973d-5b639a466a68","publishedId":"2sAYJ9AyRZ","public":true,"publicUrl":"https://developers.sportscapital.io","privateUrl":"https://go.postman.co/documentation/31769575-264252ed-8cdd-4d7b-973d-5b639a466a68","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"663399"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"SportsCapital API Reference"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/a25bca05-316f-445f-9909-c51c9b919877/V2hpdGUgbG9nbyAtIG5vIGJhY2tncm91bmQucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"663399"}},{"name":"light","logo":"https://content.pstmn.io/09c0a89f-3215-401e-b9a6-941c3b58d720/QmxhY2sgbG9nbyAtIG5vIGJhY2tncm91bmQucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"663399"}}]}},"version":"8.10.1","publishDate":"2025-02-26T03:49:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"SportsCapital API Reference","description":""},"logos":{"logoLight":"https://content.pstmn.io/09c0a89f-3215-401e-b9a6-941c3b58d720/QmxhY2sgbG9nbyAtIG5vIGJhY2tncm91bmQucG5n","logoDark":"https://content.pstmn.io/a25bca05-316f-445f-9909-c51c9b919877/V2hpdGUgbG9nbyAtIG5vIGJhY2tncm91bmQucG5n"}},"statusCode":200},"environments":[{"name":"Prod","id":"3de6d8f4-a7bd-475b-8fbf-19199a848888","owner":"31769575","values":[{"key":"base_url","value":"https://api.sportscapital.io","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/cecceab73fecf3d6bbb9d478f73adfc0c6ca95539aa960fafa680e18bb4ec8e1","favicon":"https://sportscapital.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Prod","value":"31769575-3de6d8f4-a7bd-475b-8fbf-19199a848888"}],"canonicalUrl":"https://developers.sportscapital.io/view/metadata/2sAYJ9AyRZ"}