OpenAPI definition

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

OrderController

StockController

TransactionController

UserController

OrderController

Up 
patch /api/v1/orders/cancel/{uuid}
(cancel)

Path parameters

uuid (required)
Path Parameter —

Return type

OrderDTOResponse

Example data

Content-Type: application/json
{
  "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
  "fees" : [ {
    "amount" : 1.4658129805029452,
    "name" : "name"
  }, {
    "amount" : 1.4658129805029452,
    "name" : "name"
  } ],
  "totalPrice" : 4.9437991780621135E8,
  "stockQuantity" : 1280358509,
  "stockTicker" : "stockTicker",
  "type" : "BUYING",
  "uuid" : "uuid",
  "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
  "rawPrice" : 1.210617418646223E9,
  "status" : "PENDING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OrderDTOResponse
Up 
post /api/v1/orders
(create)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body OrderDTORequest (required)
Body Parameter —

Return type

OrderDTOResponse

Example data

Content-Type: application/json
{
  "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
  "fees" : [ {
    "amount" : 1.4658129805029452,
    "name" : "name"
  }, {
    "amount" : 1.4658129805029452,
    "name" : "name"
  } ],
  "totalPrice" : 4.9437991780621135E8,
  "stockQuantity" : 1280358509,
  "stockTicker" : "stockTicker",
  "type" : "BUYING",
  "uuid" : "uuid",
  "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
  "rawPrice" : 1.210617418646223E9,
  "status" : "PENDING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OrderDTOResponse
Up 
patch /api/v1/orders/confirm/{uuid}
(execute)

Path parameters

uuid (required)
Path Parameter —

Return type

OrderDTOResponse

Example data

Content-Type: application/json
{
  "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
  "fees" : [ {
    "amount" : 1.4658129805029452,
    "name" : "name"
  }, {
    "amount" : 1.4658129805029452,
    "name" : "name"
  } ],
  "totalPrice" : 4.9437991780621135E8,
  "stockQuantity" : 1280358509,
  "stockTicker" : "stockTicker",
  "type" : "BUYING",
  "uuid" : "uuid",
  "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
  "rawPrice" : 1.210617418646223E9,
  "status" : "PENDING"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK OrderDTOResponse
Up 
get /api/v1/orders
(fetchAll)

Return type

array[OrderDTOResponse]

Example data

Content-Type: application/json
[ {
  "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
  "fees" : [ {
    "amount" : 1.4658129805029452,
    "name" : "name"
  }, {
    "amount" : 1.4658129805029452,
    "name" : "name"
  } ],
  "totalPrice" : 4.9437991780621135E8,
  "stockQuantity" : 1280358509,
  "stockTicker" : "stockTicker",
  "type" : "BUYING",
  "uuid" : "uuid",
  "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
  "rawPrice" : 1.210617418646223E9,
  "status" : "PENDING"
}, {
  "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
  "fees" : [ {
    "amount" : 1.4658129805029452,
    "name" : "name"
  }, {
    "amount" : 1.4658129805029452,
    "name" : "name"
  } ],
  "totalPrice" : 4.9437991780621135E8,
  "stockQuantity" : 1280358509,
  "stockTicker" : "stockTicker",
  "type" : "BUYING",
  "uuid" : "uuid",
  "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
  "rawPrice" : 1.210617418646223E9,
  "status" : "PENDING"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

StockController

Up 
patch /api/v1/stocks/alter/{ticker}/price
(alterStockPrice)

Path parameters

ticker (required)
Path Parameter —

Query parameters

price (required)
Query Parameter —

Return type

StockDTO

Example data

Content-Type: application/json
{
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StockDTO
Up 
delete /api/v1/stocks/delete/{ticker}
(deleteStock)

Path parameters

ticker (required)
Path Parameter —

Responses

200

OK
Up 
get /api/v1/stocks/{id}
(findStockById)

Path parameters

id (required)
Path Parameter — format: int64

Return type

StockDTO

Example data

Content-Type: application/json
{
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StockDTO
Up 
get /api/v1/stocks/ticker/{ticker}
(findStockByTicker)

Path parameters

ticker (required)
Path Parameter —

Return type

StockDTO

Example data

Content-Type: application/json
{
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StockDTO
Up 
get /api/v1/stocks
(getAll1)

Return type

array[StockDTO]

Example data

Content-Type: application/json
[ {
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
}, {
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK
Up 
post /api/v1/stocks
(insertStock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body StockDTO (required)
Body Parameter —

Return type

StockDTO

Example data

Content-Type: application/json
{
  "ticker" : "ticker",
  "price" : 0.8008281904610115,
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK StockDTO

TransactionController

Up 
post /api/v1/transactions
(createTransaction)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body TransactionDTORequest (required)
Body Parameter —

Return type

TransactionDTOResponse

Example data

Content-Type: application/json
{
  "amount" : 6.027456183070403,
  "type" : "DEPOSIT",
  "user" : {
    "name" : "name",
    "cpf" : "cpf"
  },
  "status" : "COMPLETED"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK TransactionDTOResponse

UserController

Up 
post /api/v1/users
(createUser)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AppUserDTORequest (required)
Body Parameter —

Return type

AppUserDTOResponse

Example data

Content-Type: application/json
{
  "balance" : 0.8008281904610115,
  "portfolio" : {
    "key" : 7
  },
  "cpf" : "cpf",
  "name" : "name",
  "transactionHistoryDTO" : [ {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  }, {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  } ],
  "orderHistory" : [ {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  }, {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  } ],
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AppUserDTOResponse
Up 
get /api/v1/users/cpf/{cpf}
(findUserByCpf)

Path parameters

cpf (required)
Path Parameter —

Return type

AppUserDTOResponse

Example data

Content-Type: application/json
{
  "balance" : 0.8008281904610115,
  "portfolio" : {
    "key" : 7
  },
  "cpf" : "cpf",
  "name" : "name",
  "transactionHistoryDTO" : [ {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  }, {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  } ],
  "orderHistory" : [ {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  }, {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  } ],
  "email" : "email"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AppUserDTOResponse
Up 
get /api/v1/users
(getAll)

Return type

array[AppUserDTOResponse]

Example data

Content-Type: application/json
[ {
  "balance" : 0.8008281904610115,
  "portfolio" : {
    "key" : 7
  },
  "cpf" : "cpf",
  "name" : "name",
  "transactionHistoryDTO" : [ {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  }, {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  } ],
  "orderHistory" : [ {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  }, {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  } ],
  "email" : "email"
}, {
  "balance" : 0.8008281904610115,
  "portfolio" : {
    "key" : 7
  },
  "cpf" : "cpf",
  "name" : "name",
  "transactionHistoryDTO" : [ {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  }, {
    "amount" : 6.027456183070403,
    "type" : "DEPOSIT",
    "user" : {
      "name" : "name",
      "cpf" : "cpf"
    },
    "status" : "COMPLETED"
  } ],
  "orderHistory" : [ {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  }, {
    "dateTimeExecution" : "2000-01-23T04:56:07.000+00:00",
    "fees" : [ {
      "amount" : 1.4658129805029452,
      "name" : "name"
    }, {
      "amount" : 1.4658129805029452,
      "name" : "name"
    } ],
    "totalPrice" : 4.9437991780621135E8,
    "stockQuantity" : 1280358509,
    "stockTicker" : "stockTicker",
    "type" : "BUYING",
    "uuid" : "uuid",
    "dateTimeCreation" : "2000-01-23T04:56:07.000+00:00",
    "rawPrice" : 1.210617418646223E9,
    "status" : "PENDING"
  } ],
  "email" : "email"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

Models

[ Jump to Methods ]

Table of Contents

  1. AppUserDTORequest
  2. AppUserDTOResponse
  3. FeeDTO
  4. OrderDTORequest
  5. OrderDTOResponse
  6. StockDTO
  7. TransactionDTORequest
  8. TransactionDTOResponse
  9. UserDTOForObjects

AppUserDTORequest Up

name
String
password
String
birthDate
String
cpf (optional)
String
email
String

AppUserDTOResponse Up

cpf (optional)
String
name (optional)
String
email (optional)
String
balance (optional)
BigDecimal
transactionHistoryDTO (optional)
array[TransactionDTOResponse]
orderHistory (optional)
array[OrderDTOResponse]
portfolio (optional)
map[String, Integer] format: int32

FeeDTO Up

name (optional)
String
amount (optional)
Double format: double

OrderDTORequest Up

stockTicker
String
stockQuantity (optional)
Integer format: int32
userCpf (optional)
String
type (optional)
String
Enum:
BUYING
SELLING
userPassword (optional)
String

OrderDTOResponse Up

fees (optional)
array[FeeDTO]
stockTicker (optional)
String
dateTimeExecution (optional)
Date format: date-time
uuid (optional)
String
stockQuantity
Integer format: int32
rawPrice
BigDecimal
totalPrice
BigDecimal
user (optional)
UserDTOForObjects
status (optional)
String
Enum:
PENDING
EXECUTED
CANCELED_BY_USER
CANCELED_LACK_FUNDS
CANCELED_NOT_ENOUGH_STOCK
EXPIRED
type (optional)
String
Enum:
BUYING
SELLING
dateTimeCreation
Date format: date-time

StockDTO Up

price (optional)
BigDecimal
name
String
ticker
String

TransactionDTORequest Up

userCpf (optional)
String
amount (optional)
BigDecimal
type (optional)
String
Enum:
DEPOSIT
WITHDRAWAL

TransactionDTOResponse Up

user (optional)
UserDTOForObjects
amount (optional)
BigDecimal
type (optional)
String
Enum:
DEPOSIT
WITHDRAWAL
status (optional)
String
Enum:
COMPLETED
CANCELED

UserDTOForObjects Up

name (optional)
String
cpf (optional)
String