Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.16 KB

File metadata and controls

37 lines (24 loc) · 1.16 KB

urbandictionary

Access the urbandictionary.com API from Erlang/OTP.

Warning: This API is undocumented and probably meant for internal use only. Proceed with caution.

Avoid abusing the API. Use rate limiting and caching.

Requirements:

Requires Erlang 27 or newer
Uses the new json module
0 external dependencies

Installation

You can include it in your projects as a dependency in rebar.config:

{deps, [%% ... Other dependencies
       {urbandictionary, {git, "https://github.com/hyperimpose/urbandictionary.git", {tag, "0.2.0"}}}]}.

You can also quickly compile the library and start an Erlang shell for testing with: rebar3 shell

Usage

You can directly call the functions in the urbandictionary module:

%% Get a list of definitions for a given query:
urbandictionary:define("irc").

See the source code for all the available functions.

License

This implementation of json is licensed under the BSD 3-Clause “New” or “Revised” License. A copy of this license is included in the file COPYING.