Ukhaan Tukka API

The UkhaanTukka API provides access to a list of Nepali idioms, known as ukhaan in Nepali, along with their Roman transliteration, English meaning, and an example sentence. The API makes a request to the README.md file from nepali-ukhaan repository to the fetch data and can be used to fetch the full list of ukhaan or ~~to search for a particular ukhaan based on its Nepali name, Roman transliteration, or meaning~~

This API is built using FastAPI, a modern, fast, web framework for building APIs with Python.

Endpoints

/ukhaantukka: Retrieves a paginated list of all ukhaan.
/ukhaantukka/nepali: Retrieves a paginated list of ukhaan sorted by Nepali text.
/ukhaantukka/roman: Retrieves a paginated list of ukhaan sorted by Roman text.
/ukhaantukka/meaning: Retrieves a paginated list of ukhaan sorted by their meaning.
/ukhaantukka/example: Retrieves a paginated list of ukhaan sorted by example usage.

Query Parameters

The following query parameters can be used to modify the results returned by the API:

limit: The number of ukhaan to retrieve (default: 100).
offset: The starting index of the ukhaan to retrieve (default: 0).
show_all: Whether to retrieve all ukhaan at once, without pagination (default: False).

Example Usage

To retrieve a list of ukhaan, make a GET request to the following endpoint:

http://localhost:8000/ukhaantukka

The response will be a JSON object containing a list of ukhaan. You can use the limit and offset query parameters to paginate the results. For example, to retrieve the first 10 ukhaan, you can make the following request:

http://localhost:8000/ukhaantukka?limit=10&offset=0

To retrieve all ukhaan at once, without pagination:

http://localhost:8000/ukhaantukka?show_all=true

To retrieve the first 50 ukhaan sorted by Nepali text:

http://localhost:8000/ukhaantukka/nepali?limit=50&offset=0

To retrieve the second 100 ukhaan of the second page sorted by Nepali text:

http://localhost:8000/ukhaantukka/nepali?limit=200&offset=100

Swagger Documentation

This API is documented using Swagger, an open source platform for building, documenting, and consuming RESTful web services. The Swagger documentation provides detailed information on the available endpoints, parameters, and responses, as well as examples of how to use the API.

To view the Swagger documentation for this API, open your browser and navigate to http:localhost:8000/docs or http://localhost:8000/redoc. From there, you can interact with the API directly from your rowser, and also try out different requests and see their reponses.

License

The ukhaan data used in this API is collected and forked from the nepali-ukhaan repository on GitHub and is free to use and modify under MIT license. We would like to thank Aashish Chapain and the entire community for contributing to this repository and making this API possible.