Our Web API lets your applications fetch data from the HuntScore database.
Based on simple REST principles, our Web API endpoints return metadata in JSON format about states, units, drawings, harvests, and many other useful datasets directly from the HuntScore website.
About the Web API
Through the HuntScore Web API, your applications can retrieve and manage HuntScore content. The base address of the API is http://api.huntscore.com/1.0. There are several endpoints at that address, each with its own unique path. To access all data through the Web API, an application must get permission to access the data. Authorization is via the HuntScore Accounts service.
The HuntScore Web API is based on REST principles: data resources are accessed via standard HTTPS requests in UTF-8 format to an API endpoint. Where possible, the API strives to use appropriate HTTP verbs for each action:
To make the API fast for everybody, rate limits apply. Rate limiting is applied on an application basis (based on client id), regardless of how many users are using it.
If you get status code 429, it means that you have sent too many requests. If this happens, have a look in the Retry-After header, where you will see a number displayed. This is the amount of seconds that you need to wait, before you can retry sending your requests.
All data is received as a JSON object.
Response Status Codes
The API uses the following response status codes, as defined in the RFC 2616 and RFC 6585:
Apart from the response code, unsuccessful responses return information about the error as an error JSON object containing the following information:
KEY VALUE TYPE VALUE DESCRIPTION status integer The HTTP status code (also returned in the response header; see Response Status Codes for more information). message string A short description of the cause of the error.
We require applications to authenticate all of their requests with OAuth 2 authentication. This visibility allows us to prevent abusive behavior, and it also helps us to further understand how categories of applications are using the API. We apply this understanding to better meet the needs of developers as we continue to evolve the platform.
Unless you want to write your own, you'll probably want to use an OAuth client. Here are a few we've used. Maybe they'll be useful to you.
How to use these or get setup is beyond the scope of this document. So, you're on your own.
Get all active states and related information. All U.S. states are stored in the API, however the methods listed below will only return the active states: the states with additional supporting hunting data. This is he highest level of data categorization.
Get a list of active states and their related data.
Get All States
Get a single active state and its related data.
Get A State
Get all active counties and related information. All counties are stored in the API, however the methods listed below will only return those within active states: the states with additional supporting data.
Get a list of active counties and their related data.
Get All Counties
Counties By Name
Get a list of all “active” counties by name search.
Get Counties By Name
Counties in State
Get list of counties within a specific state. Some states utilize county level data and some do not. Those that don’t use Units often make use of County data. Additionally, other data points rely on County information.
Get Counties in State
Get specific county details within a specific state.
Hunting unit data. Not all states utilize hunt units. For those that do this is the most granular data segment for that state. Harvests and Preference Point data apply to Units.
Get a list of all available hunt units. This is the base level, and every state has units.
Get All Units
Units in State
Get a list of hunt units within a specific state.
Get Units in State
Get the details for a specific hunt unit.
Get a Unit
Game harvest data for specific hunt units.
Get a list of all harvest data.
Get All Harvests
Harvests in State
Get a list of all harvest data within a specific state.
Get Harvests in State
Get harvest details for a specific hunt.
Get a Harvest
Limited license drawing summaries and data for specific hunts.
Get a list of all drawing data.
Get All Drawings
Drawings in State
Get a list of all drawing data within a specific state.
Get Drawings in State
Get drawing details for a specific hunt.
Get a Drawing
Records of trophy animals.
Get a list of all record data.
Get All Records
Records in State
Get a list of all record data within a specific state.
Get Records in State
Get records details for a specific record.
Get a Record
Important hunting and application deadline dates for various states.
Show all upcoming dates for all states and species.
Get All Records
Dates in State
Show all dates for a specific state
Get Dates in State
Photos of hunt units, trophies, or other user-submitted photos.
Show all photos for all states.
Get All Photos
Photos in State
Show all photos for a specific state (and unit)
Get Photos in State
Endpoint to access blog posts
Get all blog posts.
Get All Posts
Get a specific blog post.
Get a Post
Returns search results for units, drawings, dates, and maps.
Get a list of all search results.
Get All Search Results
This are the endpoints available to acces score data.
Endpoint to access HuntScore hunting tips. These are important hunting and application tips for various states and species.
Get all hunting available tips.
Get All Tips
Tips in State
Get available tips for a specific state.
Get Tips in State