Antler Price Tool API Documentation

Overview

The Antler Price API provides real-time pricing data for antler grades, including elk, whitetail, mule, and moose. Prices are calculated based on weighted averages of non-buyer and buyer data.

Authentication is required to use the API. A valid API key must be provided with each request. The API also includes rate-limiting to prevent overuse and abuse.

Base URL

https://www.antlerbuyers.com/api/antler-prices/

API Key Request

To access the API, you will need a valid API key. To request your API key, please visit our Contact Form and submit a request. After your request is reviewed, you will be provided with your unique API key that you can use to authenticate your API requests.

Authentication

API Key

To access the API, you must include a valid API key as a query parameter. The API key should be passed as follows:

?api_key=YOUR_API_KEY

The API key must be a 32-character hexadecimal string. If the API key is missing or invalid, an error response will be returned.

Rate Limiting

The API enforces a rate limit of 100 requests per hour per IP address. If you exceed the rate limit, the following error will be returned:

{
  "error": "Rate limit exceeded"
}
            

Parameters

api_key (Required)

• Type: String
• Description: The API key used for authentication.
• Example: a3c4b59f14b72d54ff903eb67062ef1f

Response Format

The API returns a JSON object with the following fields:

year (Integer)

The current year.

last_update (String)

The timestamp of the last update of the antler prices in the format YYYY-MM-DD HH:MM:SS.

prices (Object)

An object containing the weighted average prices of various antler grades:

{
  "elk_grade_a": "25.67",
  "elk_grade_b": "18.45",
  "elk_grade_c": "12.30",
  "whitetail_grade_a": "22.50",
  "whitetail_grade_b": "16.30",
  "whitetail_grade_c": "10.70",
  "mule_grade_a": "23.40",
  "mule_grade_b": "17.00",
  "mule_grade_c": "11.20",
  "moose_grade_a": "30.00",
  "moose_grade_b": "20.00",
  "moose_grade_c": "13.50"
}
            

Error Handling

The API will return error responses in the following cases:

• Invalid API Key: If the provided API key is invalid or missing, an error response is returned.
• Rate Limit Exceeded: If the number of requests exceeds the allowed limit (100 requests per hour), an error is returned.
• Database Query Failure: If there are issues with the database, an error message will be returned.
• Data Fetch Failure: If the API fails to retrieve necessary data, an error will be returned.

Example Error Response (Invalid API Key):

{
  "error": "Invalid API key"
}
            

Example Error Response (Rate Limit Exceeded):

{
  "error": "Rate limit exceeded"
}
            

Logging Failed Attempts

For security purposes, the API logs all failed access attempts. This includes invalid API keys, rate-limited requests, and failed database queries.