Skip to content
Grading Factors

Quickstart

This guide walks you from registration to a working API call. You’ll need curl or any HTTP client.

1. Get an API key

Section titled “1. Get an API key”

Register with your email address:

Terminal window
curl -X POST https://api.gradingfactors.ca/api/register \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

Your key is returned once — copy it immediately. See Authentication for details.

2. Fetch the grain list

Section titled “2. Fetch the grain list”

Confirm your key works by pulling the list of available grain classes:

Terminal window
curl https://api.gradingfactors.ca/api/grains \
  -H "X-API-Key: gf_live_..."

You should see a response with 9 grain classes and their metadata.

3. Fetch a full grading factor table

Section titled “3. Fetch a full grading factor table”

Pull the complete grading factor table for Canada Western Red Spring wheat:

Terminal window
curl https://api.gradingfactors.ca/api/grains/CWRS \
  -H "X-API-Key: gf_live_..."

The response includes all factor groups, factors, and per-grade thresholds for CWRS. See Field Reference for a description of every field in the response.

4. Check for updates

Section titled “4. Check for updates”

Before building against the data, check the changelog to confirm you have the current version:

Terminal window
curl https://api.gradingfactors.ca/api/changelog \
  -H "X-API-Key: gf_live_..."

What’s next

Section titled “What’s next”