# Proximi

## Description
This is version `1.0` of this API documentation. Last update on Sep 12, 2023.
# Proximi

proximi is an api service that delivers nearby services to the users. Using Proximi, one can find out nearby businesses with specified range.

## Tech Stack

- Go
- REST APIs
- Postgres
- ORM
- GeoHashing
- JWT based custom Auth

## Features

- Rate Limiting
- Authentication
- Pagination
- Geocoding
- Distance from the business.

## Procedure

- First of all, signin/signup from /auth endpoints to get the auth token (Authenticate Yourself)
- once received the token, copy the token and click on Authorize button to login urself.
- the format is `Bearer <your-token>`
- once upon verification of the token, you will be able to access protected routes such as /api endpoints

## Important

we have applied a rate limiter to make our service always available, and keep our downtime as zero.
check header to see the limit.

### Checkout our better API DOC

[https://bump.sh/harshtalks/doc/proximi/](https://bump.sh/harshtalks/doc/proximi/)


## Servers
- http://api.example.com: http://api.example.com ()

## Authentication




## Endpoints and operations

### [Auth](https://bump.sh/harshtalks/doc/proximi/group/endpoint-auth.md)
- [Basic token based Auth](https://bump.sh/harshtalks/doc/proximi/operation/operation-post-auth-signin.md)
- [For new User](https://bump.sh/harshtalks/doc/proximi/operation/operation-post-auth-signup.md)
### [Businesses](https://bump.sh/harshtalks/doc/proximi/group/endpoint-businesses.md)
- [get businesses near you](https://bump.sh/harshtalks/doc/proximi/operation/operation-get-api-businesses.md)
- [get details of a business](https://bump.sh/harshtalks/doc/proximi/operation/operation-get-api-businesses-businessid.md)



[Powered by Bump.sh](https://bump.sh)