Robot Services Exchange (RSX) API Documentation

A way for people to buy robot services by bidding and a way for robots to get jobs.

The RSX API is currently running at http://100.26.236.1:5001

Authentication Endpoints

POST /register

Parameter	Description
username	Desired username for the new account (3-20 characters)
password	Password for the new account (min 8 characters)

Username:

Password:

POST /login

Authenticate a user and receive an access token.

Parameter	Description
username	User's registered username
password	User's password

Username:

Password:

Account Management

GET /account_data

Retrieve the account data for a user.

Parameter	Description
username	User's registered username
password	User's password

Username:

Password:

Buyer Endpoints

Note: All buyer endpoints require a valid authentication token.

POST /make_bid

Submit a new bid for a robot service.

Parameter	Description
service	Type of service requested (e.g., cleaning, delivery)
lat	Latitude of the service location (-90 to 90)
lon	Longitude of the service location (-180 to 180)
price	Bid price for the service (in USD)
end_time	Unix timestamp for the end of the service period

Service:

Latitude:

Longitude:

Price (USD):

End Time (Unix Timestamp):

Seller Endpoints

Note: All seller endpoints require a valid authentication token. A supplier seat is required to access the /grab_job route.

POST /grab_job

Attempt to accept an available job for a robot.

Parameter	Description
services	List of services the robot can perform (comma-separated)
lat	Current latitude of the robot (-90 to 90)
lon	Current longitude of the robot (-180 to 180)
max_distance	Maximum distance the robot is willing to travel (in miles)

Services (comma-separated):

Latitude:

Longitude:

Max Distance (miles):

Shared Endpoints

Note: The following endpoints can be accessed by both buyers and sellers with valid authentication.

POST /nearby

Retrieve a sample of recently completed jobs.

Parameter	Description
lat	Latitude of the center point (-90 to 90)
lon	Longitude of the center point (-180 to 180)

Latitude:

Longitude:

POST /sign_job

Sign off on a completed job and provide a rating.

Parameter	Description
username	User's registered username
job_id	ID of the completed job
password	User's password
star_rating	Rating for the job (1-5 stars)

Username:

Job ID:

Password:

Star Rating (1-5):

System Check

GET /ping

Check if the API is operational.