API

Base URL

By default, the base URL of the API is http://localhost:7777. You can change this in the .env file.

A socket connection with the server can be established at ws://localhost:7777.

Authentication

Most of the endpoints require authentication. The authentication is done using JWT tokens. The user needs to send the token in the authorization header.

The socket connection is also authenticated using JWT tokens. The user needs to send the token in the token query parameter.

Endpoints

Accounts

1. Get current user: /account

• method: GET

2. Get details of a user: /account/:id

• method: GET

3. Get stats of the current user: /account/stats

• method: GET

4. Search users by a query: /account/search

• method: POST
• body: { query: string, page: number, perPage: number }

5. Update user details: /account

• method: POST
• body:

{ 
  name?: string, 
  acceptedTermsAndConditions?: boolean, 
  introDone?: boolean, 
  introSkipped?: boolean, 
  picture?: string, 
  deviceFCMToken?: string, 
  allowedNotifications?: Object | string
  meta?: Object | string
  files: File[]  
}

6. Block account: /account/update/blocked/block/:accountId

• method: PUT

7. Unblock account: /account/update/blocked/unblock/:accountId

• method: PUT

8. Delete account: /account

• method: DELETE

Auctions

1. Get latest auctions: /auction/latest

• method: GET

2. Get details of an auction: /auction/details/:id

• method: GET

3. Search auctions by a keyword: /auction/:keyword/:page/:perPage

• method: GET

4. Get active auctions owned by an account: /auction/active/:accountId

• method: POST
• body:

{ 
  page: number, 
  perPage: number 
  query?: string
  orderDirection?: ASC | DESC
  orderBy?: string
}

5. Count filtered auctions: /auction/filter/count

• method: POST
• body:

{ 
  categories: string[],
  subCategories: string[],
  locationIds: string[],
  activeOnly?: boolean
  includeMyAuctions?: boolean
  minPrice?: number
  maxPrice?: number
}

6. Get filtered auctions: /auction/filter/auctions

• method: POST
• body:

{ 
  categories: string[],
  subCategories: string[],
  locationIds: string[],
  activeOnly?: boolean
  includeMyAuctions?: boolean
  minPrice?: number
  maxPrice?: number
  page: number
  perPage: number
  orderDirection?: ASC | DESC
  orderBy?: string
}

7. Get auctions by bid status: /auction/byBid/:status

• method: POST
• body:

{ 
  page: number, 
  perPage: number 
  query?: string
  orderDirection?: ASC | DESC
  orderBy?: string
}

8. Create auction: /auction

• method: POST
• body:

{ 
  latLng: string
  location: string
  title: string
  description?: string
  price: number
  hasCustomStartingPrice: boolean
  condition: string
  mainCategoryId: string
  subCategoryId: string
  assetsToKeep: string[]
  files: File[] 
}

9. Update auction: /auction/:id

• method: PUT
• body:

{ 
  latLng: string
  location: string
  title: string
  description?: string
  price: number
  hasCustomStartingPrice: boolean
  condition: string
  mainCategoryId: string
  subCategoryId: string
  assetsToKeep: string[]
  files: File[] 
}

10. Delete auction: /auction/:id

• method: DELETE

Bids

1. Create a bid: /bid/:auctionId

• method: POST
• body:

{ 
  price: number
  description?: string
  latLng: string
  location: string
}

2. Update bid: /bid/:id

• method: PUT
• body:

{ 
  isAccepted?: boolean
  isRejected?: boolean
  rejectionReason?: string
}

3. Delete bid: /bid/:id

• method: DELETE

Categories

1. Get all categories: /category

• method: GET

Chat

1. Get current account chat groups: /chat-group

• method: GET

2. Get chat group by id: /chat-group/:id

• method: GET

3. Get messages from a chat group: /chat-group/messages/:id/:page/:perPage

• method: GET

4. Get chat groups for two accounts: /chat-group/:firstAccountId/:secondAccountId

• method: GET

5. Create chat group between current account and another: /chat-group/:accountId

• method: POST

6. Send a message: /chat-group/message/new

• method: POST
• body:

{ 
  message: string
  groupId: string
  id: string
}

7. Mark chat group messages as seen: /chat-group/seen/:groupId

• method: PUT

Favourites

1. Load account favourites: /favourites

• method: GET

2. Get accounts who added auction to favourites: /favourites/auction/:auctionId/:page/:perPage

• method: POST

3. Add auction to favourites: /favourites/add/:auctionId

• method: PUT

4. Remove auction from favourites: /favourites/remove/:auctionId

• method: PUT