Skip to content

This is an Unofficial API of the OG Urban Dictionary. Read the documentation and explore various query parameters on the playground.

License

Notifications You must be signed in to change notification settings

kashyap010/unofficial-urban-dictionary-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unofficial Urban Dictionary API

This is the repository for the Unofficial Urban Dictionary API, a RESTful API that provides access to Urban Dictionary's word definitions and related data. Data scraped from the OG Urban Dictionary

Usage

To use the Unofficial Urban Dictionary API, send HTTP GET requests to the appropriate endpoints with the necessary query parameters to retrieve the desired information. The API supports the following endpoints:

  • /api/search: Search for a given word on Urban Dictionary.
  • /api/random: Get a random word from Urban Dictionary.
  • /api/browse: Browse Urban Dictionary by A-Z, new, or *.
  • /api/author: Get definitions for a particular author.
  • /api/date: Get definitions on a particular date.

You can find more details and examples in the API documentation.

Getting Started

To run the Unofficial Urban Dictionary API locally or make modifications to the codebase, follow these steps:

  1. Clone the repository:

    git clone https://github.com/kashyap010/unofficial-urban-dictionary-api
  2. Install the dependencies:

    npm install
  3. Start the server:

    npm start

Contributing

Contributions to the Unofficial Urban Dictionary API are welcome! If you find any bugs, have suggestions for improvements, or want to add new features, please submit a pull request.

License

The Unofficial Urban Dictionary API is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.

Contact

If you have any questions or need further assistance, you can reach out to the project maintainer at kashyapshirodkar@gmail.com.

About

This is an Unofficial API of the OG Urban Dictionary. Read the documentation and explore various query parameters on the playground.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published