Oblyk Api Documentation

Welcome to the oblyk API documentation.
Here, you will find a set of endpoints allowing you to freely consult the open database of climbing crags and routes of the world.

Authorization

There are no limitations to the use of Oblyk鈥檚 APIs.
We will just ask you to register for free to get your application key which you will have to add in the header HttpApiAccessToken to access the APIs.

Create your organisation here : Oblyk - Organization
And for all your requests to the API add the following header:

HttpApiAccessToken: [your-oblyk-api-access-token]

Suggesting an evolution

If you need a particular endpoint that is not in this documentation, you can suggest that we develop it by posting an issue on the oblyk/oblyk-api GitHub project.


Enjoy reading 馃檪
Oblyk Team.

Versions

Version Date Breaking changes
1.0 2021-10-16 First commit

Crags

The most complete and interesting part of the APIs, the climbing crag endpoints !

Approaches

Get the list of approaches in relation with crag :id.

Endpoint

GET /api/v1/public/crags/:id/approaches

Response

Status: 200
[
  {
    "id": 8,
    "description": "Depuis le parking jusqu'脿 la falaise",
    "approach_type": "steep_ascent",
    "polyline": [
      [
        44.46635,
        5.05527
      ],
      [
        44.46653,
        5.05527
      ],
      [
        44.46663,
        5.05526
      ],
      [
        44.46669,
        5.05554
      ],
      [
        44.46674,
        5.05573
      ],
      [
        44.46671,
        5.05586
      ],
      [
        44.46664,
        5.05605
      ]
    ],
    "path_metadata": [
      {
        "latitude": 44.46635,
        "elevation": 529,
        "longitude": 5.05527,
        "cumulative_time": 0,
        "cumulative_distance": 0
      },
      {
        "latitude": 44.46653,
        "elevation": 531,
        "longitude": 5.05527,
        "cumulative_time": 0,
        "cumulative_distance": 20
      },
      {
        "latitude": 44.46663,
        "elevation": 531,
        "longitude": 5.05526,
        "cumulative_time": 0,
        "cumulative_distance": 31
      },
      {
        "latitude": 44.46669,
        "elevation": 536,
        "longitude": 5.05554,
        "cumulative_time": 1,
        "cumulative_distance": 54
      },
      {
        "latitude": 44.46674,
        "elevation": 540,
        "longitude": 5.05573,
        "cumulative_time": 1,
        "cumulative_distance": 70
      },
      {
        "latitude": 44.46671,
        "elevation": 542,
        "longitude": 5.05586,
        "cumulative_time": 1,
        "cumulative_distance": 81
      },
      {
        "latitude": 44.46664,
        "elevation": 544,
        "longitude": 5.05605,
        "cumulative_time": 2,
        "cumulative_distance": 98
      }
    ],
    "length": 99,
    "walking_time": 2,
    "elevation": {
      "start": 529,
      "end": 544,
      "positive_drop": 15,
      "negative_drop": 0
    },
    "crag": {
      "id": 9,
      "name": "Rocher des aures",
      "slug_name": "rocher-des-aures"
    },
    "creator": {
      "uuid": null,
      "name": null,
      "slug_name": null
    },
    "history": {
      "created_at": "2021-10-28T16:26:00.703+02:00",
      "updated_at": "2021-10-28T16:26:00.703+02:00"
    }
  }
]

Crags around lat, lng & distance

Find crags list within a distance of a gps point.

Endpoint

GET /api/v1/public/crags/crags_around

Parameters

Name Description Type Default
latitude Required Latitude of the desired point decimal
longitude Required Longitude of the desired point decimal
distance Distance in kilometres from the research integer 20

Request example

GET /api/v1/public/crags/crags_around?latitude=44.47&longitude=5.06&distance=10
Query parameters 
latitude=44.47
longitude=5.06
distance=10

Response

Status: 200
[
  {
    "id": 1,
    "name": "Rocher des aures",
    "slug_name": "rocher-des-aures",
    "rain": "exposed",
    "sun": "sunny_all_day",
    "sport_climbing": true,
    "bouldering": false,
    "multi_pitch": false,
    "trad_climbing": false,
    "aid_climbing": false,
    "deep_water": false,
    "via_ferrata": false,
    "north": null,
    "north_east": null,
    "east": null,
    "south_east": null,
    "south": true,
    "south_west": null,
    "west": null,
    "north_west": null,
    "summer": null,
    "autumn": null,
    "winter": null,
    "spring": null,
    "latitude": "44.469592",
    "longitude": "5.058089",
    "elevation": "713.0",
    "code_country": "FR",
    "country": "France",
    "city": "Roche-Saint-Secret-B茅conne",
    "region": "Dr么me",
    "rocks": [
      "limestone"
    ],
    "photo": {
      "id": null,
      "url": null,
      "thumbnail_url": null
    },
    "routes_figures": {
      "route_count": null,
      "grade": {
        "min_value": null,
        "max_value": null,
        "max_text": null,
        "min_text": null
      }
    }
  }
]

Guide books

Get the list of guides (paper, web and pdf) in relation with crag :id.

Endpoint

GET /api/v1/public/crags/:id/guides

Response

Status: 200
[
  {
    "guide_type": "GuideBookPaper",
    "guide": {
      "id": 5,
      "name": "Escalade en Dr么me Proven莽ale Sud",
      "slug_name": "escalade-en-drome-provencale-sud",
      "author": "Collectif CD FFME 26",
      "editor": "FFME",
      "publication_year": 2011,
      "price_cents": 2000,
      "ean": null,
      "vc_reference": null,
      "number_of_page": 310,
      "weight": 700,
      "price": 20,
      "cover": null,
      "thumbnail_url": null
    }
  },
  {
    "guide_type": "GuideBookWeb",
    "guide": {
      "id": 5,
      "name": "Fiche FFME Rocher des aures",
      "url": "https://www.ffme.fr/sne-fiche/238/",
      "publication_year": null,
      "crag": {
        "id": 6,
        "name": "Rocher des aures",
        "slug_name": "rocher-des-aures"
      },
      "creator": {
        "uuid": null,
        "name": null,
        "slug_name": null
      },
      "history": {
        "created_at": "2021-10-28T16:25:57.872+02:00",
        "updated_at": "2021-10-28T16:25:57.872+02:00"
      }
    }
  }
]

Parks

Get the list of parks in relation with crag :id.

Endpoint

GET /api/v1/public/crags/:id/parks

Response

Status: 200
[
  {
    "id": 7,
    "description": "Parking principal",
    "latitude": "44.46635",
    "longitude": "5.05527",
    "elevation": "529.0",
    "crag": {
      "id": 8,
      "name": "Rocher des aures",
      "slug_name": "rocher-des-aures"
    },
    "creator": {
      "uuid": null,
      "name": null,
      "slug_name": null
    },
    "history": {
      "created_at": "2021-10-28T16:25:59.753+02:00",
      "updated_at": "2021-10-28T16:25:59.753+02:00"
    }
  }
]

Routes

Get the list of routes of the crag :id.

Endpoint

GET /api/v1/public/crags/:id/crag_routes

Response

Status: 200
[
  {
    "id": 5,
    "name": "Transgression",
    "slug_name": "transgression",
    "height": 30,
    "open_year": 1998,
    "opener": "Fran莽ois Crespo",
    "climbing_type": "sport_climbing",
    "sections_count": 1,
    "max_bolt": null,
    "note": null,
    "note_count": null,
    "ascents_count": null,
    "photos_count": null,
    "videos_count": null,
    "comments_count": null,
    "votes": null,
    "difficulty_appreciation": null,
    "grade_to_s": "7c",
    "grade_gap": {
      "max_grade_value": 41,
      "min_grade_value": 41,
      "max_grade_text": "7c",
      "min_grade_text": "7c"
    },
    "crag_sector": {
      "id": 3,
      "name": "Rose des sables",
      "slug_name": "rose-des-sables",
      "photo": {
        "id": null,
        "url": null,
        "thumbnail_url": null
      }
    },
    "crag": {
      "id": 4,
      "name": "Rocher des aures",
      "slug_name": "rocher-des-aures",
      "country": "France",
      "region": "Dr么me",
      "city": "Roche-Saint-Secret-B茅conne",
      "photo": {
        "id": null,
        "url": null,
        "thumbnail_url": null
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "thumbnail_url": null
    }
  },
  {
    "id": 6,
    "name": "Joly",
    "slug_name": "joly",
    "height": 16,
    "open_year": 1997,
    "opener": "Fran莽ois Crespo",
    "climbing_type": "sport_climbing",
    "sections_count": 1,
    "max_bolt": null,
    "note": null,
    "note_count": null,
    "ascents_count": null,
    "photos_count": null,
    "videos_count": null,
    "comments_count": null,
    "votes": null,
    "difficulty_appreciation": null,
    "grade_to_s": "6b",
    "grade_gap": {
      "max_grade_value": 33,
      "min_grade_value": 33,
      "max_grade_text": "6b",
      "min_grade_text": "6b"
    },
    "crag_sector": {
      "id": 3,
      "name": "Rose des sables",
      "slug_name": "rose-des-sables",
      "photo": {
        "id": null,
        "url": null,
        "thumbnail_url": null
      }
    },
    "crag": {
      "id": 4,
      "name": "Rocher des aures",
      "slug_name": "rocher-des-aures",
      "country": "France",
      "region": "Dr么me",
      "city": "Roche-Saint-Secret-B茅conne",
      "photo": {
        "id": null,
        "url": null,
        "thumbnail_url": null
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "thumbnail_url": null
    }
  }
]

Routes figures

Get the routes statistics of crag :id.

Endpoint

GET /api/v1/public/crags/:id/route_figures

Response

Status: 200
{
  "section_count": 2,
  "route_count": 2,
  "climbing_types": {
    "sport_climbing": 2,
    "bouldering": 0,
    "multi_pitch": 0,
    "trad_climbing": 0,
    "aid_climbing": 0,
    "deep_water": 0,
    "via_ferrata": 0
  },
  "degrees": {
    "1": 0,
    "2": 0,
    "3": 0,
    "4": 0,
    "5": 0,
    "6": 1,
    "7": 1,
    "8": 0,
    "9": 0
  },
  "levels": {
    "1a": 0,
    "1b": 0,
    "1c": 0,
    "2a": 0,
    "2b": 0,
    "2c": 0,
    "3a": 0,
    "3b": 0,
    "3c": 0,
    "4a": 0,
    "4b": 0,
    "4c": 0,
    "5a": 0,
    "5b": 0,
    "5c": 0,
    "6a": 0,
    "6b": 1,
    "6c": 0,
    "7a": 0,
    "7b": 0,
    "7c": 1,
    "8a": 0,
    "8b": 0,
    "8c": 0,
    "9a": 0,
    "9b": 0,
    "9c": 0
  }
}

Sectors

Get the list of sectors of the crag :id.

Endpoint

GET /api/v1/public/crags/:id/crag_sectors

Response

Status: 200
[
  {
    "id": 4,
    "crag_id": 5,
    "name": "Rose des sables",
    "slug_name": "rose-des-sables",
    "description": null,
    "rain": "exposed",
    "sun": "sunny_all_day",
    "latitude": null,
    "longitude": null,
    "elevation": null,
    "north": null,
    "north_east": null,
    "east": null,
    "south_east": null,
    "south": null,
    "south_west": null,
    "west": null,
    "north_west": null,
    "routes_figures": {
      "count": 2,
      "grade": {
        "min_value": 33,
        "max_value": 41,
        "max_text": "7c",
        "min_text": "6b"
      }
    },
    "crag": {
      "id": 5,
      "name": "Rocher des aures",
      "slug_name": "rocher-des-aures",
      "rain": "exposed",
      "sun": "sunny_all_day",
      "sport_climbing": true,
      "bouldering": false,
      "multi_pitch": false,
      "trad_climbing": false,
      "aid_climbing": false,
      "deep_water": false,
      "via_ferrata": false,
      "north": null,
      "north_east": null,
      "east": null,
      "south_east": null,
      "south": true,
      "south_west": null,
      "west": null,
      "north_west": null,
      "summer": null,
      "autumn": null,
      "winter": null,
      "spring": null,
      "latitude": "44.469592",
      "longitude": "5.058089",
      "elevation": "713.0",
      "code_country": "FR",
      "country": "France",
      "city": "Roche-Saint-Secret-B茅conne",
      "region": "Dr么me",
      "rocks": [
        "limestone"
      ],
      "photo": {
        "id": null,
        "url": null,
        "thumbnail_url": null
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "thumbnail_url": null
    },
    "versions_count": 1,
    "photo_count": 0,
    "creator": {
      "uuid": null,
      "name": null,
      "slug_name": null
    },
    "history": {
      "created_at": "2021-10-28T16:25:56.963+02:00",
      "updated_at": "2021-10-28T16:25:57.030+02:00"
    }
  }
]

Show

Show crag :id

Endpoint

GET /api/v1/public/crags/:id

Response

Status: 200
{
  "id": 2,
  "name": "Rocher des aures",
  "slug_name": "rocher-des-aures",
  "rain": "exposed",
  "sun": "sunny_all_day",
  "sport_climbing": true,
  "bouldering": false,
  "multi_pitch": false,
  "trad_climbing": false,
  "aid_climbing": false,
  "deep_water": false,
  "via_ferrata": false,
  "north": null,
  "north_east": null,
  "east": null,
  "south_east": null,
  "south": true,
  "south_west": null,
  "west": null,
  "north_west": null,
  "summer": null,
  "autumn": null,
  "winter": null,
  "spring": null,
  "latitude": "44.469592",
  "longitude": "5.058089",
  "elevation": "713.0",
  "code_country": "FR",
  "country": "France",
  "city": "Roche-Saint-Secret-B茅conne",
  "region": "Dr么me",
  "rocks": [
    "limestone"
  ],
  "photo": {
    "id": null,
    "url": null,
    "thumbnail_url": null
  },
  "routes_figures": {
    "route_count": 2,
    "grade": {
      "min_value": 33,
      "max_value": 41,
      "max_text": "7c",
      "min_text": "6b"
    }
  },
  "comment_count": 0,
  "link_count": 0,
  "follow_count": 0,
  "park_count": 1,
  "alert_count": 0,
  "video_count": 0,
  "photo_count": 0,
  "versions_count": 1,
  "articles_count": null,
  "all_photos_count": 0,
  "all_videos_count": 0,
  "guide_books": {
    "web_count": 1,
    "pdf_count": 0,
    "paper_count": 1
  },
  "creator": {
    "uuid": null,
    "name": null,
    "slug_name": null
  },
  "sectors": [
    {
      "id": 1,
      "name": "Rose des sables"
    }
  ],
  "areas": [
    {
      "id": 1,
      "name": "Dr么me proven莽ale",
      "slug_name": "drome-provencale"
    }
  ],
  "history": {
    "created_at": "2021-10-28T16:25:53.417+02:00",
    "updated_at": "2021-10-28T16:25:53.654+02:00"
  }
}

Types

This part of the API documentation shows you the different types of elements that oblyk uses, such as bolt types, sunlight, rain exposure, etc.

Anchors

List of the types of anchors that can be found on a climbing route.

Endpoint

GET /api/v1/public/anchors

Response

Status: 200
[
  "bolted_anchor_chains",
  "bolted_anchor_no_chains",
  "pigtail_anchors",
  "traditional_anchor",
  "no_anchor"
]

Bolts

List of the types of bolts that can be found on a climbing route.

Endpoint

GET /api/v1/public/bolts

Response

Status: 200
[
  "forged_eye_bolts",
  "bolt_hangers",
  "open_staple_bolts",
  "staple_u_bolts",
  "no_bolts"
]

Climbs

List of the types of climbs.

Endpoint

GET /api/v1/public/climbs

Response

Status: 200
[
  "sport_climbing",
  "bouldering",
  "multi_pitch",
  "trad_climbing",
  "aid_climbing",
  "deep_water",
  "via_ferrata"
]

Inclines

List of the types of inclines that can be found on a climbing route.

Endpoint

GET /api/v1/public/inclines

Response

Status: 200
[
  "slab",
  "vertical",
  "slight_overhang",
  "overhang",
  "roof"
]

Rains

List of types of exposures to rains from a crag.

Endpoint

GET /api/v1/public/rains

Response

Status: 200
[
  "protected",
  "exposed"
]

Receptions

List of boulder receptions types.

Endpoint

GET /api/v1/public/receptions

Response

Status: 200
[
  "good",
  "correct",
  "bad",
  "dangerous"
]

Rocks

List of types of rocks from a crag.

Endpoint

GET /api/v1/public/rocks

Response

Status: 200
[
  "slate",
  "limestone",
  "conglomerate",
  "gabbro",
  "gneiss",
  "granite",
  "sandstone",
  "migmatite",
  "molasses",
  "quartzite",
  "serpentinite",
  "silex",
  "basalt",
  "rhyolite",
  "andesite",
  "schist",
  "phonolite",
  "resin"
]

Starts

List of boulder start types.

Endpoint

GET /api/v1/public/starts

Response

Status: 200
[
  "sit",
  "down",
  "stand",
  "jump",
  "run_and_jump"
]

Suns

List of types of suns exposures a crag can have.

Endpoint

GET /api/v1/public/suns

Response

Status: 200
[
  "sunny_all_day",
  "shady",
  "sunny_afternoon",
  "sunny_morning"
]

Words

The climbing glossary create by climbers community

Index

List words in glossary

Endpoint

GET /api/v1/public/words

Parameters

Name Description Type Default
page Page of pagination integer 1

Request example

GET /api/v1/public/words?page=1
Query parameters 
page=1

Response

Status: 200
[
  {
    "id": 1,
    "name": "Climbing",
    "slug_name": "climbing",
    "definition": "Best sport ever",
    "versions_count": 1,
    "creator": {
      "uuid": null,
      "name": null,
      "slug_name": null
    },
    "history": {
      "created_at": "2021-10-28T16:26:02.021+02:00",
      "updated_at": "2021-10-28T16:26:02.021+02:00"
    }
  },
  {
    "id": 2,
    "name": "Oblyk",
    "slug_name": "oblyk",
    "definition": "Best climbing community ever : )",
    "versions_count": 1,
    "creator": {
      "uuid": null,
      "name": null,
      "slug_name": null
    },
    "history": {
      "created_at": "2021-10-28T16:26:02.030+02:00",
      "updated_at": "2021-10-28T16:26:02.030+02:00"
    }
  }
]

Show

Show word by :id

Endpoint

GET /api/v1/public/words/:id

Response

Status: 200
{
  "id": 4,
  "name": "Oblyk",
  "slug_name": "oblyk",
  "definition": "Best climbing community ever : )",
  "versions_count": 1,
  "creator": {
    "uuid": null,
    "name": null,
    "slug_name": null
  },
  "history": {
    "created_at": "2021-10-28T16:26:02.082+02:00",
    "updated_at": "2021-10-28T16:26:02.082+02:00"
  }
}