Giter Site home page Giter Site logo

vichaar's Introduction

Table of Contents

Introduction

Vichaar is a RESTful web API that lets you fetch one or n thoughts (quotes) from a database of 10,000+ thoughts (quotes).

Features

List of topics is available here.

Lingo

Vichaar's lingo is an amalgam of two languages. The greatest one (let's not start a war) and the most popular one. Below is a list of five Hindi words you need to know to use Vichaar.

Vocab

# Word Hindi
1 Sankhya Number (ID)
2 Vichaar Thought (Quote)
3 Vichaarak Thinker (Author)
4 Vishay Topic
5 Bhaasha Language

Now with these five Hindi words under your belt, you are all set to play with the API.

Documentation

Base URL: https://vichaar.herokuapp.com

Fetch A Particular Thought

Fetch a particular thought from the database with its ID.

  • URL

    /

  • Method

    GET

  • URL Params

    Required:

    sankhya=[ID]

  • Success Response

    • Code: 200 OK

    • Content:

      [
          {
              "sankhya":1234,
              "vichaar":"It's all about quality of life and finding a happy balance between work and  friends and family.",
              "vichaarak":"Philip Green",
              "vishay":"Life",
              "bhaasha":"English"
          }
      ]
  • Error Response

    • Code: 304 NOT MODIFIED
    • Content: []
  • Sample Call

    curl --request GET \
      --url 'https://vichaar.herokuapp.com/?sankhya=1234'
    
  • Note

    304 NOT MODIFIED simply means that the requested thought was not found, hence an empty array [] is returned.

Fetch A Random Thought

Fetch a random thought from the database.

  • URL

    /random

  • Method

    GET

  • Success Response

    • Code: 200 OK

    • Content:

      [
          {
              "sankhya":6480,
              "vichaar":"I like long walks, especially when they are taken by people who annoy me.",
              "vichaarak":"Fred Allen",
              "vishay":"Funny",
              "bhaasha":"English"
          }
      ]
  • Sample Call

    curl --request GET \
      --url https://vichaar.herokuapp.com/random
    

Fetch N Random Thoughts

Fetch n number of random thoughts from the database.

  • URL

    /random

  • Method

    GET

  • URL Params

    Required:

    n=[Number]

  • Success Response

    • Code: 200 OK

    • Content:

      [
          {
              "sankhya":1042,
              "vichaar":"February days are a marketing gimmick; love happens every day.",
              "vichaarak":"Randeep Hooda",
              "vishay":"Love",
              "bhaasha":"English"
          },
          {
              "sankhya":2778,
              "vichaar":"We must not show to all and sundry the secrets of the waters flowing in ocean and river, or the devices that work on these waters. Let there be convened a council of experts and masters in mechanical art to deliberate what is needed to compose and construct these works.",
              "vichaarak":"Filippo Brunelleschi",
              "vishay":"Art",
              "bhaasha":"English"
          },
          {
              "sankhya":3222,
              "vichaar":"Rock n' roll as a genre is different from pop and hip hop: it is about bands, and that for me suggests brotherhood, family, friendship and community.",
              "vichaarak":"Steven Van Zandt",
              "vishay":"Friendship",
              "bhaasha":"English"
          },
          {
              "sankhya":6726,
              "vichaar":"I think it's great to see how they've grown up, not just as actors but as people. They're still very much the same kids that I met many years ago. They've grown up and they are funny and wicked and    naughty and bright, and I think as actors their work is just getting better and better. They've blossomed.",
              "vichaarak":"David Heyman",
              "vishay":"Funny",
              "bhaasha":"English"
          },
          {
              "sankhya":7413,
              "vichaar":"I wish people would turn off their computers, go outside, talk to people, touch people, lick people, enjoy each other's company and smell each other on the rump.",
              "vichaarak":"Tre Cool",
              "vishay":"Computer",
              "bhaasha":"English"
          }
      ]
  • Sample Call

    curl --request GET \
      --url 'https://vichaar.herokuapp.com/random?n=5'
    

Fetch A Random Thought Of A Particular Topic

Fetch a random thought of a particular topic from the database.

  • URL

    /random

  • Method

    GET

  • URL Params

    Required:

    vishay=[Topic]

  • Success Response

    • Code: 200 OK
    • Content:
    [
        {
            "sankhya":7413,
            "vichaar":"I wish people would turn off their computers, go outside, talk to people, touch people, lick people, enjoy each other's company and smell each other on the rump.",
            "vichaarak":"Tre Cool",
            "vishay":"Computer",
            "bhaasha":"English"
        }
    ]
  • Sample Call

    curl --request GET \
      --url 'https://vichaar.herokuapp.com/random?vishay=Computer'
    

Fetch N Random Thoughts Of A Particular Topic

Fetch n random thoughts of a particular topic from the database.

  • URL

    /random

  • Method

    GET

  • URL Params

    Required:

    vishay=[Topic]

    n=[Number]

  • Success Response

    • Code: 200 OK
    • Content:
    [
        {
            "sankhya":7137,
            "vichaar":"I know that I'm going to die and that you're going to die. I can't do anything about that. But I can explore it through a metaphor and make a kind of funny, dark story about it, and in doing so, really exhaust and research as many aspects of it as I can imagine. And in a way, that does give me some closure.",
            "vichaarak":"Chuck Palahniuk",
            "vishay":"Funny",
            "bhaasha":"English"
        },
        {
            "sankhya":7138,
            "vichaar":"I have only been funny about seventy four per cent of the time. Yes I think that is right. Seventy-four per cent of the time.",
            "vichaarak":"Will Ferrell",
            "vishay":"Funny",
            "bhaasha":"English"
        },
        {
            "sankhya":7139,
            "vichaar":"James Caan told me at the end of filming 'Elf' that he had been waiting through the whole film for me to be funny - and I never was.",
            "vichaarak":"Will Ferrell",
            "vishay":"Funny",
            "bhaasha":"English"
        },
        {
            "sankhya":7140,
            "vichaar":"There's always going to be someone as funny as you or funnier.",
            "vichaarak":"Will Ferrell",
            "vishay":"Funny",
            "bhaasha":"English"
        },
        {
            "sankhya":7141,
            "vichaar":"I was the kid next door's imaginary friend.",
            "vichaarak":"Emo Philips",
            "vishay":"Funny",
            "bhaasha":"English"
        }
    ]
  • Sample Call

    curl --request GET \
      --url 'https://vichaar.herokuapp.com/random?vishay=Funny&n=5'
    

Attribution

BrainyQuote

Signing-off, Abhay Kumar

vichaar's People

Contributors

abhaykumarvats avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.