GithubHelp home page GithubHelp logo

cafes's Introduction

# NYC Cafes API

Welcome to the NYC Cafes API! This API provides information about cafes in New York City, allowing you to explore various parameters such as wifi availability, power outlets, and vibes.

## Base URL

The base URL for the API is: `https://nyccafesapi.onrender.com/`

## Endpoints

### Get all cafes

**Endpoint:**

GET /cafes


**Description:**
Retrieve information about all cafes in New York City.

**Example Request:**
```bash
curl https://nyccafesapi.onrender.com/cafes

Search for cafes

Endpoint:

GET /cafes/search

Parameters:

  • wifi (optional): Filter cafes by wifi availability. Values: true or false.
  • powerOutlets (optional): Filter cafes by power outlets availability. Values: true or false.
  • vibes (optional): Filter cafes by vibes. Provide a string value for the desired vibes.

Example Request:

curl 'https://nyccafesapi.onrender.com/cafes/search?wifi=true&powerOutlets=true&vibes=Cozy'

Note: Adjust query parameters based on your preferences.

Response Format

The API returns data in JSON format. Here's an example response:

[
  {
    "id": 1,
    "name": "Cafe A",
    "location": "New York, NY",
    "wifi": true,
    "powerOutlets": true,
    "vibes": "Cozy"
  },
  {
    "id": 2,
    "name": "Cafe B",
    "location": "New York, NY",
    "wifi": true,
    "powerOutlets": false,
    "vibes": "Hipster"
  }
]

Getting Started

To get started, you can use tools like curl or Postman to make HTTP requests to the provided endpoints. Adjust query parameters as needed to filter cafes based on your preferences.

cafes's People

Contributors

ishaanndas avatar

Watchers

 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.