The MoonBase API is a RESTful service structured by object-oriented endpoints, utilizing standard HTTP response codes and verbs. Before building your MoonBase, let's review a few concepts:
\nMay we suggest a gradual approach:
\nDocumentation: https://moonbase.codespan.com
Base API URL: https://moonbase-v1.codespan.com
All endpoints return JSON-encoded responses and standard HTTP status codes.
\nError response examples:
\nResponse (401): {\"message\": \"Unable to authenticate.\"}
Response (404): {\"message\": \"Object could not be found.\"}
Response (429): {\"message\": \"Your account has been locked for 1 hour.\"}
Response (500): {\"message\": \"Our server experienced an unexpected error. We have been alerted to this error, please try again later.\"}
Note: This endpoint is rate limited to 5 requests per hour, per email address.
\n","urlObject":{"protocol":"https","path":["tokens",""],"host":["moonbase-v1","codespan","com"],"query":[],"variable":[]}},"response":[{"id":"2d878597-b705-4536-85b7-d62ca0e60198","name":"Tokens","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"george.p.burdell@codespan.com\",\r\n \"password\": \"iHeartCodeSpan\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://moonbase-v1.codespan.com/tokens/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token\": \"9e04d2c7-3733-4a30-bbc9-637cc4ba323a\",\n \"expires\": \"2021-10-26 23:56:35.113643+00:00\"\n}"}],"_postman_id":"6df6f6b4-7945-4a31-9636-61256eed7e22"}],"id":"ec2ff987-3e64-42e8-a39d-eaa975904ea3","description":"Email and password combinations are required to generate tokens which are used for authorizing subsequent API calls. Tokens are accepted for 12 hours after generation; it is suggested to cache your token expiration timestamp locally, although it is acceptable to attempt API actions to determine token validity and re-authenticate as necessary. The token is passed as Authorization in the header for all subsequent calls.
Note: An optional query string parameter fields accepts a comma delimited value of the definition keys and dictates the structure of the response; ex: ?fields=statuses,missions.
Note: only GET requests are allowed.
An optional query string param fields is available in order to limit which definitions are included in the response.
Note: Only GET and POST requests are allowed and only 1 Epoch can be in progress at a time.
Note: only the GET method is supported.
Required fields:
\nEither name or status is required to be in the body.
The DELETE method requires the user to extend the URL with the ID of the Facility they want to delete.
Methods: GET, POST, PATCH, DELETE
Note: Deleting a facility will return 75% of the construction costs to your reserves, provided there is available storage capacity.
\nNote: Use the PATCH request to repair damaged facilities, provided you have the necessary resources, which cost 25% of the original construction cost.
Required fields:
\nEither name or status is required to be in the body.
Methods: GET, POST, PATCH, DELETE
Note: You must build a Vehicle Assembly Plant before building any vehicles.
Note: Deleting a vehicle will return 50% of the construction costs to your reserves, provided there is available storage capacity.
\nNote: Use the PATCH request to repair damaged vehicles, provided you have the necessary resources, which cost 25% of the original construction cost.
Required fields:
\nRequired field:
\nMethods: GET, POST, PATCH, DELETE
Note: Deleting a mission will return the associated vehicles to the AWAITING DEPLOYMENT status.
Note: Use the PATCH request to resume a delayed mission, provided you have the necessary resources, which costs 15% of the reward.
Note: only the GET method is supported.
Once you build a Mining Technology Laboratory or Energy Technology Laboratory your scientists will get to work and improve the MoonBase's resource gathering efficiency. With each discovery your Energy Research Bonus or Ore Research Bonus will rise, which increases that resources daily output and reward from completed missions!