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’s 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

Areas

Areas are groupings of climbing sites, they allow the creation of logical groups such as the “Forest of Fontainebleau”, or the Calanques

Crags

Get crags in area :id

Endpoint

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

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,
      "cropped_url": null,
      "thumbnail_url": null
    },
    "approaches": {
      "min_time": null,
      "max_time": null
    },
    "routes_figures": {
      "route_count": null,
      "grade": {
        "min_value": null,
        "max_value": null,
        "max_text": null,
        "min_text": null
      }
    }
  }
]

GeoJson

Get geo_json of the climbing sites, parks, approach, sectors in the area :id

Endpoint

GET /api/v1/public/areas/:id/geo_json

Response

Status: 200
{
  "type": "FeatureCollection",
  "crs": {
    "type": "name",
    "properties": {
      "name": "urn"
    }
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "type": "Crag",
        "id": 7,
        "name": "Rocher des aures",
        "slug_name": "rocher-des-aures",
        "climbing_key": "10000",
        "icon": "crag-marker-10000",
        "localization": "Roche-Saint-Secret-BĂ©conne, DrĂ´me",
        "sport_climbing": true,
        "bouldering": false,
        "multi_pitch": false,
        "trad_climbing": false,
        "aid_climbing": false,
        "deep_water": false,
        "via_ferrata": false,
        "map_thumbnail_url": null,
        "route_count": null,
        "grade_min_value": null,
        "grade_max_value": null,
        "grade_max_text": null,
        "grade_min_text": null
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.058089,
          44.469592,
          0.0
        ]
      }
    }
  ]
}

Index

Show oblyk areas

Endpoint

GET /api/v1/public/areas

Response

Status: 200
[
  {
    "id": 2,
    "name": "ForĂŞt de Fontainebleau",
    "slug_name": "foret-de-fontainebleau",
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null,
      "illustrable_type": null,
      "illustrable_name": null
    }
  },
  {
    "id": 3,
    "name": "Parc national des Calanques",
    "slug_name": "parc-national-des-calanques",
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null,
      "illustrable_type": null,
      "illustrable_name": null
    }
  }
]

Paper guide books

Get all paper guide books that cover the crags in the area :id

Endpoint

GET /api/v1/public/areas/:id/guide_book_papers

Response

Status: 200
[
  {
    "id": 1,
    "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.0",
    "funding_status": null,
    "cover": null,
    "thumbnail_url": null
  }
]

Photos

Get photos of the climbing sites in the area :id

Endpoint

GET /api/v1/public/areas/:id/photos

Response

Status: 200
[

]

Routes

Get crag routes in the area :id

Optional parameters :

  • page : Page number. set all for all results. default: 1
  • page_limit : number of results per page. default: 25

Endpoint

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

Response

Status: 200
[
  {
    "id": 3,
    "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": 2,
      "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"
        }
      },
      "photo": {
        "id": null,
        "url": null,
        "cropped_url": null,
        "thumbnail_url": null
      }
    },
    "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null
    }
  },
  {
    "id": 4,
    "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": 2,
      "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"
        }
      },
      "photo": {
        "id": null,
        "url": null,
        "cropped_url": null,
        "thumbnail_url": null
      }
    },
    "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null
    }
  }
]

Search routes by grade

Search route in area id filtered by grade. You can put two grades separated by a space to go up all the routes between these two grades (see example below).

Example for grade params:

  • 6a : return all the 6a of the area
  • 6a 6a+ : return all the 6a and 6a+ of the area
  • 7 : return all the routes in the 7th degree (from 7a to 7c+)
  • 5c 6b : return all routes between 5c and 6b

Endpoint

GET /api/v1/public/areas/:id/crag_routes/search_by_grades

Parameters

Name Description Type
grade Required Grade sought string

Request example

GET /api/v1/public/areas/11/crag_routes/search_by_grades?grade=6b
Query parameters
grade=6b

Response

Status: 200
[
  {
    "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,
      "crag_id": 6,
      "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"
        }
      },
      "photo": {
        "id": null,
        "url": null,
        "cropped_url": null,
        "thumbnail_url": null
      }
    },
    "crag": {
      "id": 6,
      "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null
    }
  }
]

Show

Show area :id

Endpoint

GET /api/v1/public/areas/:id

Response

Status: 200
{
  "id": 4,
  "name": "Drôme provençale",
  "slug_name": "drome-provencale",
  "photo": {
    "id": null,
    "url": null,
    "cropped_url": null,
    "thumbnail_url": null,
    "illustrable_type": null,
    "illustrable_name": null
  },
  "crags_count": 1,
  "crag_routes_count": 0,
  "area_crags": [
    {
      "id": 1,
      "crags": {
        "id": 1,
        "name": "Rocher des aures"
      }
    }
  ],
  "routes_figures": {
    "routes_count": 0,
    "grade": {
      "min_value": null,
      "min_text": null,
      "max_value": null,
      "max_text": null
    }
  },
  "creator": null,
  "history": {
    "created_at": "2022-08-14T18:04:29.566+02:00",
    "updated_at": "2022-08-14T18:04:29.566+02:00"
  }
}

CragRoutes

The crag_routes represent a line of boulder, routes, multi pitch, trad, aid, deep water or via ferrata.
A crag_route necessarily belongs to a climbing site (crag) and optionally to a sector of a crag (crag_sectors).

Show

Show crag_route :id

Endpoint

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

Response

Status: 200
{
  "id": 7,
  "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": null,
  "crag": {
    "id": 8,
    "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,
      "cropped_url": null,
      "thumbnail_url": null
    },
    "approaches": {
      "min_time": null,
      "max_time": null
    },
    "routes_figures": {
      "route_count": 1,
      "grade": {
        "min_value": 33,
        "max_value": 33,
        "max_text": "6b",
        "min_text": "6b"
      }
    }
  },
  "photo": {
    "id": null,
    "url": null,
    "cropped_url": null,
    "thumbnail_url": null
  },
  "versions_count": 1,
  "sections": [
    {
      "tags": null,
      "grade": "6b",
      "height": 16,
      "bolt_type": null,
      "bolt_count": null,
      "start_type": null,
      "anchor_type": null,
      "description": null,
      "grade_value": 33,
      "incline_type": "vertical",
      "climbing_type": "sport_climbing",
      "reception_type": null
    }
  ],
  "ascent_comments": [

  ],
  "link_count": 0,
  "alert_count": 0,
  "creator": null,
  "history": {
    "created_at": "2022-08-14T18:04:35.927+02:00",
    "updated_at": "2022-08-14T18:04:35.927+02:00"
  }
}

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": 11,
    "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,
    "from_park": true,
    "elevation": {
      "start": 529,
      "end": 544,
      "positive_drop": 15,
      "negative_drop": 0
    },
    "crag": {
      "id": 17,
      "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "creator": null,
    "history": {
      "created_at": "2022-08-14T18:04:43.964+02:00",
      "updated_at": "2022-08-14T18:04:43.964+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": 9,
    "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,
      "cropped_url": null,
      "thumbnail_url": null
    },
    "approaches": {
      "min_time": null,
      "max_time": 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": 8,
      "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.0",
      "funding_status": null,
      "cover": null,
      "thumbnail_url": null
    }
  },
  {
    "guide_type": "GuideBookWeb",
    "guide": {
      "id": 8,
      "name": "Fiche FFME Rocher des aures",
      "url": "https://www.ffme.fr/sne-fiche/238/",
      "publication_year": null,
      "crag": {
        "id": 14,
        "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,
          "cropped_url": null,
          "thumbnail_url": null
        },
        "approaches": {
          "min_time": 2,
          "max_time": 2
        },
        "routes_figures": {
          "route_count": 2,
          "grade": {
            "min_value": 33,
            "max_value": 41,
            "max_text": "7c",
            "min_text": "6b"
          }
        }
      },
      "creator": null,
      "history": {
        "created_at": "2022-08-14T18:04:40.877+02:00",
        "updated_at": "2022-08-14T18:04:40.877+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": 10,
    "description": "Parking principal",
    "latitude": "44.46635",
    "longitude": "5.05527",
    "elevation": "529.0"
  }
]

Routes

Get the list of routes of the crag :id.

Endpoint

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

Response

Status: 200
[
  {
    "id": 12,
    "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": 6,
      "crag_id": 12,
      "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"
        }
      },
      "photo": {
        "id": null,
        "url": null,
        "cropped_url": null,
        "thumbnail_url": null
      }
    },
    "crag": {
      "id": 12,
      "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null
    }
  },
  {
    "id": 13,
    "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": 6,
      "crag_id": 12,
      "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"
        }
      },
      "photo": {
        "id": null,
        "url": null,
        "cropped_url": null,
        "thumbnail_url": null
      }
    },
    "crag": {
      "id": 12,
      "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_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,
  "grade": {
    "min": {
      "value": 33,
      "text": "6b",
      "crag_route": {
        "id": 19,
        "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": 9,
          "crag_id": 15,
          "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"
            }
          },
          "photo": {
            "id": null,
            "url": null,
            "cropped_url": null,
            "thumbnail_url": null
          }
        },
        "crag": {
          "id": 15,
          "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,
            "cropped_url": null,
            "thumbnail_url": null
          },
          "approaches": {
            "min_time": 2,
            "max_time": 2
          },
          "routes_figures": {
            "route_count": 2,
            "grade": {
              "min_value": 33,
              "max_value": 41,
              "max_text": "7c",
              "min_text": "6b"
            }
          }
        },
        "photo": {
          "id": null,
          "url": null,
          "cropped_url": null,
          "thumbnail_url": null
        }
      }
    },
    "max": {
      "value": 41,
      "text": "7c",
      "crag_route": {
        "id": 18,
        "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": 9,
          "crag_id": 15,
          "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"
            }
          },
          "photo": {
            "id": null,
            "url": null,
            "cropped_url": null,
            "thumbnail_url": null
          }
        },
        "crag": {
          "id": 15,
          "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,
            "cropped_url": null,
            "thumbnail_url": null
          },
          "approaches": {
            "min_time": 2,
            "max_time": 2
          },
          "routes_figures": {
            "route_count": 2,
            "grade": {
              "min_value": 33,
              "max_value": 41,
              "max_text": "7c",
              "min_text": "6b"
            }
          }
        },
        "photo": {
          "id": null,
          "url": null,
          "cropped_url": null,
          "thumbnail_url": null
        }
      }
    }
  },
  "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": 7,
    "crag_id": 13,
    "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"
      }
    },
    "photo": {
      "id": null,
      "url": null,
      "cropped_url": null,
      "thumbnail_url": null
    },
    "crag": {
      "id": 13,
      "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,
        "cropped_url": null,
        "thumbnail_url": null
      },
      "approaches": {
        "min_time": 2,
        "max_time": 2
      },
      "routes_figures": {
        "route_count": 2,
        "grade": {
          "min_value": 33,
          "max_value": 41,
          "max_text": "7c",
          "min_text": "6b"
        }
      }
    }
  }
]

Show

Show crag :id

Endpoint

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

Response

Status: 200
{
  "id": 10,
  "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,
    "cropped_url": null,
    "thumbnail_url": null
  },
  "approaches": {
    "min_time": 2,
    "max_time": 2
  },
  "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": null,
  "sectors": [
    {
      "id": 4,
      "name": "Rose des sables"
    }
  ],
  "areas": [
    {
      "id": 14,
      "name": "Drôme provençale",
      "slug_name": "drome-provencale"
    }
  ],
  "history": {
    "created_at": "2022-08-14T18:04:36.564+02:00",
    "updated_at": "2022-08-14T18:04:37.263+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"
  },
  {
    "id": 2,
    "name": "Oblyk",
    "slug_name": "oblyk",
    "definition": "Best climbing community ever : )"
  }
]

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": null,
  "history": {
    "created_at": "2022-08-14T18:04:45.899+02:00",
    "updated_at": "2022-08-14T18:04:45.899+02:00"
  }
}