Tags | API | Automation |
Overview
NOTE: Though Stack Overflow still supports API v2.3, we encourage all users to migrate to the improved API v3. Learn more about API v3.
The Stack Overflow for Teams API enables you to interact with your Stack Overflow site programmatically with external scripts, reporting tools and automated workflows.
How you authenticate into and access API v2.3 depends on your Stack Overflow for Teams version. Follow the appropriate link below to learn more:
Stack Overflow for Teams Free has no API access. Teams Basic offers read-only API v2.3 access, while Teams Business and Enterprise can use API v2.3 to read and write data. Find your plan.
API sandbox
The documentation for API v2.3 includes a sandbox environment for trying out different API endpoints and gaining experience with the API responses and data models. For more information, see the “API documentation sandbox” section of the relevant document linked above.
API write operations
Using the Stack Overflow API to add or edit content involves additional considerations and concerns. If not done with care, automating the addition of new content can decrease user engagement. Learn more about using the API to write data in the Use the Write API article.
Throttling
API v2.3 uses request throttling to prevent abuse and maintain site performance and stability. These throttles include an overall request limit per day per user, dynamic throttles (which generate the backoff parameter), and burst throttles to limit the number of write actions completed in quick succession.
API v2.3 throttling thresholds are generous. If your site begins throttling API calls, consider whether you're using the API as efficiently as possible. For example: no application should make semantically identical requests more than once a minute. This can be a waste of bandwidth as it usually returns the same data.
Troubleshooting
To maintain security of data and stability of the site, Stack Overflow will reject certain API requests. Here are some of the most common reasons:
Teams Basic and Business
Invalid/missing PAT
Invalid/missing team slug
Expired PAT
PAT not associated with specified team
Write operation specified for read-only PAT
Inadequate user permissions
Too many API calls in a given time period (throttling)
Teams Enterprise
Invalid/missing API access key
Expired OAuth access token (write actions)
Write operation using access key instead of OAuth access token
Write operation specified for read-only API Application
Inadequate user permissions
Too many API calls in a given time period (throttling)
SOE PDF documentation
Stack Overflow Enterprise users can download the API v2.3 PDF documentation below.
Need help? Submit an issue or question through our support portal.