Introduction

Back to pbjwrites.info

Welcome to the Bicycle Inventory API! You can use this API to access Bicycle Inventory endpoints, which can get information on all road bikes past or present in my database.

There are language bindings in Shell, Ruby, Python, and JavaScript! You can view code example and switch the programming language of the examples.

Authentication

Not yet required.

Bicycles

List all bicycles

require 'bicycle_inventory'

api = bicycle_inventory::APIClient.authorize!('bicycle_inventory_api_key')
api.bicycles.get

import bicycle_inventory

api = bicycle_inventory.authorize('bicycle_inventory_api_key')
api.bicycles.get()

curl "http://pbjwrites.info/api/bicycles" \
  -H "Authorization: bicycle_inventory_api_key"

const bicycle_inventory = require('bicycle_inventory');

let api = bicycle_inventory.authorize('bicycle_inventory_api_key');
let bicycles = api.bicycles.get();

The above command returns JSON structured like this:

{
    "total_bicycles": "4",
    "bicycles": [
        {
            "bicycle_id": 1,
            "make": "Specialized",
            "model": "Sequoia Sport",
            "groupset": "Shimano Sora",
            "frame_type": "aluminum",
            "frame_size": "60cm",
            "prime_color": "silver",
            "model_year": 2003,
            "crank_length": "175mm"
        },
        {
            "bicycle_id": 2,
            "make": "Cannondale",
            "model": "CAAD8",
            "groupset": "Shimano Tiagra",
            "frame_type": "aluminum",
            "frame_size": "58cm",
            "prime_color": "white",
            "model_year": 2014,
            "crank_length": "172.5mm"
        },
        {
            "bicycle_id": 3,
            "make": "Cannondale",
            "model": "CAAD13 Disc Rival AXS",
            "groupset": "Rival eTAP",
            "frame_type": "aluminum",
            "frame_size": "58cm",
            "prime_color": "purple",
            "model_year": 2021,
            "crank_length": "175mm"
        },
        {
            "bicycle_id": 4,
            "make": "Cannondale",
            "model": "Topstone 4",
            "groupset": "microSHIFT Advent 10",
            "frame_type": "aluminum",
            "frame_size": "large",
            "prime_color": "alpine",
            "model_year": 2021,
            "crank_length": "175mm"
        }
    ]
}

This endpoint retrieves all bicycles.

HTTP Request

GET http://pbjwrites.info/api/bicycles

Query Parameters

Add a new bicycle

require 'bicycle_inventory'

api = bicycle_inventory::APIClient.authorize!('bicycle_inventory_api_key')
api.bicycles.post(2)

import bicycle_inventory

api = bicycle_inventory.authorize('bicycle_inventory_api_key')
api.bicycles.post(2)

curl "http://pbjwrites.info/api/bicycles/2" \
  -X POST \
  -H "Authorization: bicycle_inventory_api_key"

const bicycle_inventory = require('bicycle_inventory');

let api = bicycle_inventory.authorize('bicycle_inventory_api_key');
let max = api.bicycles.POST(2);

The above command returns JSON structured like this:

{
  "Bicycle created successfully"
}

This endpoint adds a new bicycle.

HTTP Request

POST http://pbjwrites.info/bicycles/{bicycle_id}

URL Parameters

Request Body Example

{
    "make": "Cannondale",
    "model": "CAAD8",
    "groupset": "Shimano Tiagra",
    "frame_type": "aluminum",
    "frame_size": "58cm",
    "prime_color": "white",
    "model_year": 2014,
    "crank_length": "172.5mm"
},

Update an existing bicycle

require 'bicycle_inventory'

api = bicycle_inventory::APIClient.authorize!('bicycle_inventory_api_key')
api.bicycles.put(2)

import bicycle_inventory

api = bicycle_inventory.authorize('bicycle_inventory_api_key')
api.bicycles.put(2)

curl "http://pbjwrites.info/api/bicycles/2" \
  -X PUT \
  -H "Authorization: bicycle_inventory_api_key"

const bicycle_inventory = require('bicycle_inventory');

let api = bicycle_inventory.authorize('bicycle_inventory_api_key');
let max = api.bicycles.PUT(2);

The above command returns JSON structured like this:

{
  "Bicycle updated successfully"
}

This endpoint deletes a specific bicycle.

HTTP Request

PUT http://pbjwrites.info/bicycles/{bicycle_id}

URL Parameters

Parameter	Description
bicycle_id	The ID of the bicycle to update

Request Body Example

{
    "make": "Cannondale",
    "model": "SuperSix EVO Hi-MOD 1",
    "groupset": "SRAM RED AXS",
    "frame_type": "carbon",
    "frame_size": "58cm",
    "prime_color": "mercury",
    "model_year": 2024,
    "crank_length": "175mm"
}

Delete a specific bicycle

require 'bicycle_inventory'

api = bicycle_inventory::APIClient.authorize!('bicycle_inventory_api_key')
api.bicycles.delete(2)

import bicycle_inventory

api = bicycle_inventory.authorize('bicycle_inventory_api_key')
api.bicycles.delete(2)

curl "http://pbjwrites.info/api/bicycles/2" \
  -X DELETE \
  -H "Authorization: bicycle_inventory_api_key"

const bicycle_inventory = require('bicycle_inventory');

let api = bicycle_inventory.authorize('bicycle_inventory_api_key');
let max = api.bicycles.delete(2);

The above command returns JSON structured like this:

{
  "Bicycle deleted successfully"
}

This endpoint deletes a specific bicycle.

HTTP Request

DELETE http://pbjwrites.info/bicycles/{bicycle_id}

URL Parameters

Parameter	Description
bicycle_id	The ID of the bicycle to delete

Errors

The Bicycle Inventory API uses the following error codes:

Error Code	Meaning
400	Bonked Request -- Your request is invalid.
401	Dropped -- Your API key is wrong.
403	Yellow Jersey Only -- The bike you requested is hidden for TdF leaders only.
404	Not Found -- The specified bike could not be found.
405	Drafting Not Allowed -- You tried to access a TT bike with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The bike requested has been removed from our servers.
429	Too Many Requests -- You're requesting too many bicycles! Ain't rich!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.