Exchange Mobile API

HTTP | HTTPS://seatsx.com/exchange-mobileapi

Version v1

APIs

/exchange-mobileapi/accountBalance

GET

User account balance

Security

• Bearer Token

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	AccountBalanceResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/all/{communityType}/{pageNumber}/{pageSize}

GET

All communities

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
communityType	path	yes		–	string
pageNumber	path	yes		–	integer (int32)
pageSize	path	yes		–	integer (int32)

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/followed/{communityType}

GET

All followed communities

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
communityType	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/prices

GET

Communities last prices

Security

• Bearer Token

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesPricesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/recommended/{communityType}/{pageNumber}/{pageSize}

POST

Recommended communities

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
communityType	path	yes		–	string
pageNumber	path	yes		–	integer (int32)
pageSize	path	yes		–	integer (int32)
body	body	yes		–	GetCommunitiesRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/search/{communityType}/{query}/{pageNumber}/{pageSize}

GET

Search communities

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
communityType	path	yes		–	string
query	path	yes		–	string
pageNumber	path	yes		–	integer (int32)
pageSize	path	yes		–	integer (int32)

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/communities/searchByHub/{communityType}/{query}/{pageNumber}/{pageSize}

GET

Search communities

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
communityType	path	yes		–	string
query	path	yes		–	string
pageNumber	path	yes		–	integer (int32)
pageSize	path	yes		–	integer (int32)

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunitiesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comment/delete/{id}

GET

Delete community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comment/dislike/{id}

GET

Dislike community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	LikeResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comment/like/{id}

GET

Like community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	LikeResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comment/post

POST

Post a community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	PostCommunityCommentRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comment/replies/{id}

GET

Get community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	GetCommunityCommentsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/comments/get/{id}

GET

Get community comments

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	GetCommunityCommentsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/follow/{id}

GET

Follow community

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunityFollowResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/unfollow/{id}

GET

Unfollow community

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/community/{id}

GET

Get commute community

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	CommunityDetailsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/emergency/call

GET

Emergency Call

Security

• Bearer Token

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/emergency/call/{tripId}

GET

Emergency Call

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
tripId	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/emergency/video

POST

Upload video

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	Picture

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/emergency/video/{tripId}

POST

Upload video

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
tripId	path	yes		–	string
body	body	yes		–	Picture

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/exchangetypes

GET

Exchange types

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	ExchangeTypesResponse

/exchange-mobileapi/highestTrading

POST

Highest trading pair

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	HighestTradingRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	HighestTradingResponse

/exchange-mobileapi/hubs/get

POST

Get hubs close to location

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	GetHubsRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	GetHubsResponse

/exchange-mobileapi/hubs/orderdata/{hubId}

GET

Get hub order data

Request

Parameters

Name	Located in	Required	Description	Default	Schema
hubId	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	HubOrderDataResponse

/exchange-mobileapi/location/update

POST

Trop location update

Security

• Bearer Token

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	LocationUpdateRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	LocationUpdateResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/login

POST

User login

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	LoginRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	LoginResponse
403	Invalid user name or password	–

/exchange-mobileapi/login/recovery

POST

User id and password recovery

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	LoginRecoveryRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse

/exchange-mobileapi/logout

GET

User logout

Security

• Bearer Token

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/orders/delete/{id}

GET

Delete order

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/orders/find

POST

Find orders for route

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	FindOrdersRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	FindOrdersResponse

/exchange-mobileapi/orders/get/{hubType}

GET

User open orders

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
hubType	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	OrdersResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/orders/place

POST

Place new order

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	PlaceOrderRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	PlaceOrderResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/paypal/checkout

POST

Paypal checkout

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	PaypalCheckoutRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	AccountBalanceResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/paypal/configuration

GET

Paypal configuration

Security

• Bearer Token

Request

Parameters

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	PaypalConfigurationResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/paypal/payment

POST

Paypal payment

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	PaypalPaymentRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	AccountBalanceResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/route/delete/{id}

GET

Delete user route

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/route/notifications

POST

Update route notifications

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	UpdateNotificationsRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/route/{id}

GET

Get user route

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	UserRouteResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/routes/{hubType}

GET

Get active user routes

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
hubType	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	UserRoutesResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/signup

POST

New user signup

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	SignupRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse

/exchange-mobileapi/signup/driver

POST

driver register

Security

• Bearer

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	DriverSignupRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/stripe/payment/intent

POST

Create Stripe payment intent

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	StripePaymentRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	StripePaymentResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/stripe/payment/verify

POST

Verify Stripe payment

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	StripePaymentVerifyRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	StripePaymentVerifyResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/message

POST

Send trip message

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	TripMessageRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/message/{id}

GET

Trip message

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripMessages
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/messages/{id}

GET

Trip messages

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripMessages
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/add

POST

Add trip stop

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	TripStop

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	ResponseWithId
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/complete/{id}

GET

Complete trip stop

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/delete/{id}

GET

Delete trip stop

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/get/{id}

GET

Trip stop details

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripStopDetailsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/picture/add/{id}

POST

Add picture to trip stop

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string
body	body	yes		–	Picture

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	ResponseWithId
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/picture/delete/{stopId}/{picId}

GET

Delete trip stop picture

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
stopId	path	yes		–	string
picId	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/picture/{id}

GET

Trip picture

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	PictureResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/requestConfirmation/{id}

GET

Request trip stop confirmation

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stop/review

POST

Post trip stop review

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	TripStopReview

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	ResponseWithId
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stops/getall/{id}

GET

Trip stops

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripStopsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trip/stops/reorder

POST

Reorder trip stops

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	StopsReorderRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	BaseResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trips/past/{hubType}

GET

User trips

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
hubType	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/trips/upcoming/{hubType}

GET

User upcoming trips

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
hubType	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	TripsResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/withdrawal

POST

Acount withdrawal

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
body	body	yes		–	WithdrawalRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	WithdrawalResponse
401	Missing or invalid authorization	–

/exchange-mobileapi/zoom/meeting/{id}

GET

Zoom meeting info

Security

• Bearer Token

Request

Parameters

Name	Located in	Required	Description	Default	Schema
id	path	yes		–	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	successful operation	ZoomMeetingDataResponse
401	Missing or invalid authorization	–

Definitions

AccountBalanceResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
balance	number (double)	optional	–
availableBalance	number (double)	optional	–

Address

name	type	required	description	example
country	string	required	–
city	string	required	–
addressLine1	string	required	–
addressLine2	string	optional	–
state	string	required	–
zip	string	required	–
building	string	optional	–

BaseResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–

CommunitiesPricesResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
communities	array[CommunityPrices]	required	–

CommunitiesResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
totalPages	integer (int32)	required	–
communities	array[Community]	required	–
communityIcons	array[CommunityIcon]	required	–

Community

name	type	required	description	example
id	string	required	–
routeId	string	required	–
about	string	required	–
name	string	required	–
shortName	string	required	–
city	string	required	–
state	string	required	–
country	string	required	–
feed	string	required	–
pickupHubId	string	required	–
dropoffHubId	string	required	–
followers	integer (int64)	required	–
isFollowed	boolean	required	–
communityType	string	required	–
communityUrl	string	optional	–
startDate	string (date-time)	required	–
endDate	string (date-time)	required	–

CommunityComment

name	type	required	description	example
id	string	optional	–
comment	string	required	–
commentPictureFileName	string	optional	–
commentPicture	string	optional	–	Base64 encoded
userPictureFileName	string	optional	–
userPicture	string	optional	–	Base64 encoded
userId	string	optional	–
userName	string	optional	–
dateTime	string (date-time)	optional	–
numLikes	integer (int32)	optional	–
numDislikes	integer (int32)	optional	–
numComments	integer (int32)	optional	–

CommunityDetailsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
startHub	Hub	required	–
endHub	Hub	required	–
stats	CommunityStats	required	–
url	string	optional	–
communityType	string	required	–
communityPicture	Picture	optional	–

CommunityFollowResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
route	UserRoute	required	–

CommunityIcon

name	type	required	description	example
communityType	string	required	–
communityIcon	Picture	required	–

CommunityPrices

name	type	required	description	example
communityId	string	required	–
communityShortName	string	required	–
prevClose	number (double)	required	–
lastPrice	number (double)	required	–

CommunityStats

name	type	required	description	example
riders	integer (int32)	required	–
rides	integer (int32)	required	–
drivers	integer (int32)	required	–
seats	integer (int32)	required	–
followers	integer (int32)	required	–
frequency	number (double)	required	–
dayHigh	number (double)	required	–
dayLow	number (double)	required	–
yearHigh	number (double)	required	–
yearLow	number (double)	required	–
volume	integer (int64)	required	–

DriverInsurance

name	type	required	description	example
company	string	required	–
phoneNumber	string	required	–
policyId	string	required	–
startDate	string (date-time)	required	–	2020-01-22T09:20
endDate	string (date)	required	–	2020-01-22

DriverLicense

name	type	required	description	example
number	string	required	–
state	string	required	–
expirationDate	string (date)	required	–

DriverSignupRequest

name	type	required	description	example
vehicle	DriverVehicle	required	–
insurance	DriverInsurance	required	–
license	DriverLicense	required	–

DriverVehicle

name	type	required	description	example
make	string	required	–
model	string	required	–
year	string	required	–
color	string	required	–
vin	string	required	–
licensePlate	string	required	–
state	string	required	–
seatingCapacity	integer (int32)	required	–

ExchangeType

name	type	required	description	example
exchange	string	required	–
id	string	required	–
name	string	required	–
description	string	required	–
parentId	string	required	–
subtypes	array[string]	required	–
smallIcon	Picture	required	–
mediumIcon	Picture	required	–
largeIcon	Picture	required	–

ExchangeTypesResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
types	array[ExchangeType]	required	–

FindOrdersRequest

name	type	required	description	example
hubType	string	required	–	all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring
tripDate	string (date)	required	–	2019-03-22
startTime	string	required	–	HHmm
maxOffsetMinutes	integer (int32)	required	–
routes	array[Route]	required	–
proximityMiles	number (double)	required	–
maxHubPairs	integer (int32)	required	–

FindOrdersResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
routes	array[RouteHubs]	required	–

GetCommunitiesRequest

name	type	required	description	example
location	Position2d	required	–

GetCommunityCommentsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
comments	array[CommunityComment]	required	–

GetHubsRequest

name	type	required	description	example
hubType	string	required	–	all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring
location	Position2d	required	–
radius	number (double)	required	–

GetHubsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
hubs	array[Hub]	required	–

HighestTradingRequest

name	type	required	description	example
position	Position2d	required	–
radius	number (double)	required	–
hubType	string	required	–	all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring

HighestTradingResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
hub1	array[Hub]	required	–
hub2	array[Hub]	required	–
contractCount	integer (int32)	required	–

Hub

name	type	required	description	example
id	string	required	–
name	string	required	–
latitude	number (double)	required	–
longitude	number (double)	required	–
address	string	required	–
hubTypes	array[string]	required	–	all, commute, store, farm, parking, sidewalk, advertising, freight, mobility, tutoring

HubOrderData

name	type	required	description	example
hubType	string	required	–
buyPrice	number (double)	required	–
sellPrice	number (double)	required	–

HubOrderDataResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
orderData	array[HubOrderData]	required	–

HubPairOrders

name	type	required	description	example
startHub	Hub	required	–
endHub	Hub	required	–
distance	number (double)	required	–
orders	array[RouteOrder]	required	–

LikeResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
numLikes	integer (int32)	required	–
numDislikes	integer (int32)	required	–

LocationUpdateRequest

name	type	required	description	example
tripId	string	required	–
position	Position2d	required	–
speed	number (double)	required	–
heading	number (double)	required	–
accuracy	number (double)	required	–
altitudeAccuracy	number (double)	required	–

LocationUpdateResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
status	string	required	–	FUTURE, UPCOMING, AT_START, DELAYED, STARTED, ONGOING, PASSED_HALF_WAY, HALF_WAY, AFTER_MIDWAY, ARRIVED, COMPLETE, CANCELLED, EXPIRED

LoginRecoveryRequest

name	type	required	description	example
credential	string	required	–	username, password
email	string	required	–

LoginRequest

name	type	required	description	example
username	string	required	–
password	string	required	–

LoginResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
auth_token	string	required	–
userId	string	required	–
driverId	string	required	–

OpenOrder

name	type	required	description	example
id	string	required	–
orderDescription	string	required	–
tripDescription	string	required	–
timeZone	string	required	–

OrderDetails

name	type	required	description	example
tripDate	string (date)	required	–	2019-11-27
tripTime	string	required	–	HHmm
startHubId	string	required	–
endHubId	string	required	–

OrdersResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
orders	array[OpenOrder]	optional	–

PaypalCheckoutRequest

name	type	required	description	example
paymentMethodNonce	string	required	–
payerId	string	required	–
orderId	string	required	–
amount	number (double)	required	–

PaypalConfigurationResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
env	string	required	–
clientId	string	required	–
braintreeEnv	string	required	–

PaypalPaymentRequest

name	type	required	description	example
transactionId	string	required	–
success	boolean	required	–
amount	number (double)	required	–

Picture

name	type	required	description	example
fileName	string	required	–
picture	string	required	–	Base64 encoded

PictureResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
fileName	string	required	–
picture	string	required	–	Base64 encoded

PlaceOrderRequest

name	type	required	description	example
orderType	string	required	–	buy, sell
price	number (double)	required	–
quantity	integer (int32)	required	–
contractId	string	optional	–
orderDetails	OrderDetails	optional	–

PlaceOrderResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
contractId	string	required	–
newOrderId	string	required	–
orderTopic	string	required	–
contractTradeStatsTopic	string	required	–
contractMarketDepthTopic	string	required	–

Position2d

name	type	required	description	example
lat	number (double)	required	–
lon	number (double)	required	–

PostCommunityCommentRequest

name	type	required	description	example
communityId	string	optional	–
replyTo	string	optional	–
comment	CommunityComment	required	–

ResponseWithId

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
Id	string	required	–

Route

name	type	required	description	example
positions	array[Position2d]	required	–

RouteHubs

name	type	required	description	example
routeIndex	integer (int32)	required	–
hubPairs	array[HubPairOrders]	required	–

RouteOrder

name	type	required	description	example
orderId	string	required	–
orderType	string	required	–	buy, sell
price	number (double)	required	–
quantity	integer (int32)	required	–
contractId	string	required	–
tripDate	string	required	–	2019-11-27
tripTime	string	required	–	HHmm
orderTopic	string	required	–
contractTradeStatsTopic	string	required	–
contractMarketDepthTopic	string	required	–

SignupRequest

name	type	required	description	example
username	string	required	–
password	string	required	–
firstname	string	required	–
lastname	string	required	–
email	string	required	–
phone	string	required	–
dob	string (date)	required	–	1990-03-22
gender	string	required	–	male, female
felony	boolean	required	–
sexOffender	boolean	required	–
address	Address	required	–
userProfilePicture	UserProfilePicture	required	–

StopSeqOrder

name	type	required	description	example
stopId	string	required	–
stopOrder	integer (int64)	required	–

StopsReorderRequest

name	type	required	description	example
stops	array[StopSeqOrder]	required	–

StripePaymentRequest

name	type	required	description	example
amount	number (double)	required	–

StripePaymentResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
paymentIntentId	string	required	–
clientSecret	string	required	–
stripePublicKey	string	required	–

StripePaymentVerifyRequest

name	type	required	description	example
paymentIntentId	string	required	–

StripePaymentVerifyResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
balance	number (double)	optional	–
availableBalance	number (double)	optional	–
status	string	required	–

TripInstance

name	type	required	description	example
id	string	required	–
startHub	Hub	required	–
endHub	Hub	required	–
driverId	string	required	–
driverUserId	string	required	–
driverName	string	required	–
vehicleId	string	required	–
passengerIds	array[string]	required	–
passengerNames	array[string]	required	–
distance	number (double)	required	–
status	string	required	–	FUTURE, UPCOMING, AT_START, DELAYED, STARTED, ONGOING, PASSED_HALF_WAY, HALF_WAY, AFTER_MIDWAY, ARRIVED, COMPLETE, CANCELLED, EXPIRED
startTime	string (date-time)	required	–
tripTopic	string	required	–
numStops	integer (int32)	required	–
reviews	array[TripReview]	optional	–
communityName	string	optional	–
communityPicture	Picture	optional	–
meetingId	string	optional	–

TripMessage

name	type	required	description	example
messageId	string	required	–
fromDriver	boolean	required	–
sender	string	required	–
senderName	string	required	–
time	string	required	–
text	string	required	–

TripMessageRequest

name	type	required	description	example
tripId	string	required	–
isDriver	boolean	required	–
message	string	required	–

TripMessages

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
messages	array[TripMessage]	required	–

TripReview

name	type	required	description	example
comment	string	optional	–
user	string	required	–
rating	number (double)	required	–

TripStop

name	type	required	description	example
tripId	string	required	–
address	Address	optional	–
lastName	string	required	–
firstName	string	required	–
email	string	required	–
phone	string	required	–
order	integer (int64)	required	–
position	Position2d	required	–
packageId	string	required	–
completionTime	string (date-time)	optional	–
pictures	array[string]	optional	–
review	TripStopReview	optional	–

TripStopDetailsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
stop	TripStop	required	–

TripStopItem

name	type	required	description	example
stopId	string	optional	–
address	Address	optional	–
order	integer (int64)	required	–
location	Position2d	required	–
completionTime	string (date-time)	optional	–

TripStopReview

name	type	required	description	example
tripId	string	required	–
stopId	string	required	–
serviceQuality	string	required	–
cleanliness	string	required	–
routeComment	string	required	–
comment	string	required	–
rating	number (double)	required	–

TripStopsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
stops	array[TripStopItem]	required	–

TripsResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
trips	array[TripInstance]	optional	–

UpdateNotificationsRequest

name	type	required	description	example
routeId	string	required	–
email	boolean	required	–
text	boolean	required	–

UserProfilePicture

name	type	required	description	example
fileName	string	required	–
base64data	string	required	–

UserRoute

name	type	required	description	example
id	string	required	–
time	string	required	–	HHmm
description	string	required	–
startHub	string	required	–
endHub	string	required	–
emailNotification	boolean	required	–
textNotification	boolean	required	–

UserRouteResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
route	UserRoute	required	–
startHub	Hub	required	–
endHub	Hub	required	–

UserRoutesResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
routes	array[UserRoute]	required	–	HHmm

WithdrawalRequest

name	type	required	description	example
type	string	required	–	zelle, paypal, check, trade, commission
amount	number (double)	required	–
email	string	optional	–	For Paypal or Zelle withdrawals
phoneNumber	string	optional	–	For Paypal or Zelle withdrawals
deliveryMethod	string	optional	–	For check withdrawals: firstClass or overnight

WithdrawalResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
balance	number (double)	optional	–
availableBalance	number (double)	optional	–
confirmation	string	required	–

ZoomMeetingDataResponse

name	type	required	description	example
result	string	required	–	ok, error
errorDetails	string	optional	–
exceptionInfo	string	optional	–
meetingTopic	string	required	–
meetingDuration	integer (int32)	required	–
startUrl	string	required	–
joinUrl	string	required	–
password	string	required	–
h323_password	string	required	–
pstn_password	string	required	–