https://github.com/khalby786/friendly-words

API for the friendly-words npm package.
https://github.com/khalby786/friendly-words

api friendly-words glitch npm-package serverless serverless-functions vercel

Last synced: 3 days ago
JSON representation

API for the friendly-words npm package.

• Host: GitHub
• URL: https://github.com/khalby786/friendly-words
• Owner: khalby786
• License: mit
• Created: 2020-12-20T07:34:22.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-20T14:38:30.000Z (about 4 years ago)
• Last Synced: 2024-04-28T05:23:23.906Z (8 months ago)
• Topics: api, friendly-words, glitch, npm-package, serverless, serverless-functions, vercel
• Language: TypeScript
• Homepage: https://friendlywords.now.sh
• Size: 9.77 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# friendly-words

API for the friendly-words npm package by Glitch.

## Endpoints

`https://friendlywords.now.sh/api/predicates`

```json

{

    "predicates": [ "thorn" ] 

}

```

`https://friendlywords.now.sh/api/objects`

```json

{

    "objects": [ "glitter" ]

}

```

`https://friendlywords.now.sh/api/teams`

```json 

{

    "teams": [ "conglomerate" ]

}

```

`https://friendlywords.now.sh/api/collections`

```json

{

    "collections": [ "nest" ]

}

```

`https://friendlywords.now.sh/api/word-pairs`

```json

{

  "paired_words": [

    "boatneck-emperor"

  ]

}

```

`https://friendlywords.now.sh/api/team-pairs`

```json

{

  "paired_teams": [

    "positive-lineup"

  ]

}

```

`https://friendlywords.now.sh/api/collection-pairs`

```json

{

  "paired_words": [

    "flicker-playlist"

  ]

}

```

All the above endpoints return one word each. If you want more than one word or word pairs, append `?num=NUMBER_OF_WORDS` to the URL.

*Example:*

https://friendlywords.now.sh/api/collections?num=20

```json

{

  "collections": [

    "supply",

    "potpourri",

    "pack",

    "batch",

    "list",

    "bouquet",

    "troupe",

    "assembly",

    "stockpile",

    "cumulation",

    "herd",

    "jumble",

    "organization",

    "mix",

    "miscellany",

    "florilegium",

    "album",

    "compilation",

    "store",

    "selection"

  ]

}

```

Made with 🍩s by [Khaleel Gibran](https://github.com/khalby786).