Django Napse API 0.0.1

List and description of all endpoints. This API documentation is essentially generated automatically. It may therefore contain errors. If you see an error, please open an issue, and if you would like to improve it, please make a contribution.

---

bot

---

GET /api/bot/

Description

Return a list of bots.

Warning: space_containers can lead to undesirable behaviour.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "name": "string",
        "uuid": "5ab3b4ac-6939-4c8e-9736-00183c265711",
        "value": 10.12,
        "delta": 10.12,
        "fleet": "string",
        "space": "d0a8692d-a410-4ff4-b611-1bdf99a81656",
        "exchange_account": "4d0a4af9-4c86-4480-9426-cc105b0deac3"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Bot"
    }
}

---

GET /api/bot/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	string		No

Response 200 OK

application/json

{
    "name": "string",
    "uuid": "d0fcd7a1-56c0-4190-8dd0-e6b6687e1c98",
    "value": 10.12,
    "delta": 10.12,
    "statistics": {},
    "fleet": "string",
    "space": "072a66ba-0e7e-47f2-ab18-fd1c8ac04b40",
    "exchange_account": "string",
    "wallet": "string",
    "orders": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "description": "Deep dive in bot's data for serialization.",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Return value market of the bot, depending of space containerization.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        },
        "statistics": {
            "type": "object",
            "additionalProperties": {
                "oneOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "integer"
                    },
                    {
                        "type": "number",
                        "format": "double"
                    }
                ]
            },
            "description": "Return Bot's statistics.",
            "readOnly": true
        },
        "fleet": {
            "type": "string",
            "readOnly": true
        },
        "space": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "Return the space used for the space containerization.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        },
        "wallet": {
            "type": "string",
            "readOnly": true
        },
        "orders": {
            "type": "string",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "exchange_account",
        "fleet",
        "orders",
        "space",
        "statistics",
        "uuid",
        "value",
        "wallet"
    ]
}

exchange_account

---

GET /api/exchange_account/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "uuid": "9f330e1b-4392-42c7-b129-3b9411854057",
        "exchange": "string",
        "name": "string",
        "description": "string",
        "testing": true
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ExchangeAccount"
    }
}

---

POST /api/exchange_account/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "uuid": "bdb39542-f716-4762-be28-b1a3b14ee207",
    "exchange": "string",
    "name": "string",
    "description": "string",
    "testing": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        }
    },
    "required": [
        "description",
        "exchange",
        "name",
        "testing",
        "uuid"
    ]
}

{
    "uuid": "e32c4fc9-3aa0-425d-a9d4-1696fd99d7f9",
    "exchange": "string",
    "name": "string",
    "description": "string",
    "testing": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        }
    },
    "required": [
        "description",
        "exchange",
        "name",
        "testing",
        "uuid"
    ]
}

{
    "uuid": "6d0551f6-d137-432d-b70a-4da9d7f7cfe1",
    "exchange": "string",
    "name": "string",
    "description": "string",
    "testing": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        }
    },
    "required": [
        "description",
        "exchange",
        "name",
        "testing",
        "uuid"
    ]
}

Response 201 Created

application/json

{
    "uuid": "ae68bfeb-57e6-4b8c-b177-788142685bd7",
    "exchange": "string",
    "name": "string",
    "description": "string",
    "testing": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        }
    },
    "required": [
        "description",
        "exchange",
        "name",
        "testing",
        "uuid"
    ]
}

---

GET /api/exchange_account/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this exchange account.

Response 200 OK

application/json

{
    "uuid": "3c517fb4-0a2b-499e-8d5b-602cec6fa55c",
    "exchange": "string",
    "name": "string",
    "testing": true,
    "description": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "spaces": [
        {
            "name": "string",
            "description": "string",
            "exchange_account": "string",
            "uuid": "4a349031-1b11-4cd4-a2c1-df29c1e76afa",
            "testing": true,
            "value": 10.12,
            "delta": 10.12
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        },
        "description": {
            "type": "string"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
        },
        "spaces": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Space"
            },
            "readOnly": true
        }
    },
    "required": [
        "created_at",
        "description",
        "exchange",
        "name",
        "spaces",
        "testing",
        "uuid"
    ]
}

---

DELETE /api/exchange_account/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this exchange account.

Response 204 No Content

---

GET /api/exchange_account/possible_exchanges/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

{
    "uuid": "52e6da01-1078-4bf3-a616-ba2ab6cd3d69",
    "exchange": "string",
    "name": "string",
    "description": "string",
    "testing": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "exchange": {
            "type": "string"
        },
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "testing": {
            "type": "boolean",
            "readOnly": true
        }
    },
    "required": [
        "description",
        "exchange",
        "name",
        "testing",
        "uuid"
    ]
}

fleet

---

GET /api/fleet/

Description

View of a fleet.

Query parameters: space: uuid of the space to filter on. space_containers (bool): If True, list endpoint returns fleets for each space (default = True).

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "name": "string",
        "clusters": [
            {
                "template_bot": "ced60598-92d8-4abe-b6ac-ffd066278f35",
                "share": 10.12,
                "breakpoint": 0,
                "autoscale": true
            }
        ],
        "space": "8c2e7993-771e-4e49-83c7-5b63a663cb88",
        "uuid": "d629ca98-bd17-4a72-8f42-b19faf3c4fbe",
        "value": "string",
        "bot_count": "string",
        "delta": 10.12,
        "exchange_account": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Fleet"
    }
}

---

POST /api/fleet/

Description

View of a fleet.

Query parameters: space: uuid of the space to filter on. space_containers (bool): If True, list endpoint returns fleets for each space (default = True).

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "name": "string",
    "clusters": [
        {
            "template_bot": "1b75aaf3-83ef-47f8-b55d-be1d0b102b0b",
            "share": 10.12,
            "breakpoint": 0,
            "autoscale": true
        }
    ],
    "space": "2518e3cc-f363-476f-81c0-a5a8e0ec3a3e",
    "uuid": "312f2bdc-0ceb-494b-a623-12a6cdcb4de6",
    "value": "string",
    "bot_count": "string",
    "delta": 10.12,
    "exchange_account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "clusters": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ClusterFormatter"
            },
            "writeOnly": true
        },
        "space": {
            "type": "string",
            "format": "uuid",
            "writeOnly": true
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "value": {
            "type": "string",
            "readOnly": true
        },
        "bot_count": {
            "type": "string",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        }
    },
    "required": [
        "bot_count",
        "clusters",
        "delta",
        "exchange_account",
        "space",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "clusters": [
        {
            "template_bot": "39a9e503-8bcf-4f48-ad74-ed7ff6a5fad1",
            "share": 10.12,
            "breakpoint": 0,
            "autoscale": true
        }
    ],
    "space": "f11a0ad4-1ef5-4c11-a37c-e4825a423db0",
    "uuid": "0c55d553-41ee-479b-8c9c-e6d42da919a0",
    "value": "string",
    "bot_count": "string",
    "delta": 10.12,
    "exchange_account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "clusters": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ClusterFormatter"
            },
            "writeOnly": true
        },
        "space": {
            "type": "string",
            "format": "uuid",
            "writeOnly": true
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "value": {
            "type": "string",
            "readOnly": true
        },
        "bot_count": {
            "type": "string",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        }
    },
    "required": [
        "bot_count",
        "clusters",
        "delta",
        "exchange_account",
        "space",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "clusters": [
        {
            "template_bot": "44d8efd8-27e3-487e-98e2-99f6953b20cf",
            "share": 10.12,
            "breakpoint": 0,
            "autoscale": true
        }
    ],
    "space": "9cc05f76-177b-4c17-9eb9-79b451aa2798",
    "uuid": "9289c09d-68d2-4555-9d21-ce36ab6921b0",
    "value": "string",
    "bot_count": "string",
    "delta": 10.12,
    "exchange_account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "clusters": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ClusterFormatter"
            },
            "writeOnly": true
        },
        "space": {
            "type": "string",
            "format": "uuid",
            "writeOnly": true
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "value": {
            "type": "string",
            "readOnly": true
        },
        "bot_count": {
            "type": "string",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        }
    },
    "required": [
        "bot_count",
        "clusters",
        "delta",
        "exchange_account",
        "space",
        "uuid",
        "value"
    ]
}

Response 201 Created

application/json

{
    "name": "string",
    "clusters": [
        {
            "template_bot": "8136a5a7-a338-48ea-94f1-a8405ed992e2",
            "share": 10.12,
            "breakpoint": 0,
            "autoscale": true
        }
    ],
    "space": "9379b3bb-00fd-45a7-8482-076084bc77ac",
    "uuid": "0881a2cf-0e29-48f2-bea7-10ed6800b52c",
    "value": "string",
    "bot_count": "string",
    "delta": 10.12,
    "exchange_account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "clusters": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ClusterFormatter"
            },
            "writeOnly": true
        },
        "space": {
            "type": "string",
            "format": "uuid",
            "writeOnly": true
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "value": {
            "type": "string",
            "readOnly": true
        },
        "bot_count": {
            "type": "string",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        }
    },
    "required": [
        "bot_count",
        "clusters",
        "delta",
        "exchange_account",
        "space",
        "uuid",
        "value"
    ]
}

---

GET /api/fleet/{id}/

Description

View of a fleet.

Query parameters: space: uuid of the space to filter on. space_containers (bool): If True, list endpoint returns fleets for each space (default = True).

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this fleet.

Response 200 OK

application/json

{
    "uuid": "97aa4c17-a48f-4b1f-aa37-85c4912e0f1e",
    "name": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "statistics": "string",
    "wallet": "string",
    "bots": [
        {
            "name": "string",
            "uuid": "1e042d19-3514-42c6-830d-a817e897082b",
            "value": 10.12,
            "delta": 10.12,
            "fleet": "string",
            "space": "77393b21-2df5-41b8-8ac4-ea8d6436a3b6",
            "exchange_account": "82708e57-ed94-4ca9-b93e-4b3ecbdc9e56"
        }
    ],
    "exchange_account": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "name": {
            "type": "string",
            "maxLength": 100
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
        },
        "statistics": {
            "type": "string",
            "readOnly": true
        },
        "wallet": {
            "type": "string",
            "readOnly": true
        },
        "bots": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Bot"
            },
            "readOnly": true
        },
        "exchange_account": {
            "type": "integer"
        }
    },
    "required": [
        "bots",
        "created_at",
        "exchange_account",
        "statistics",
        "uuid",
        "wallet"
    ]
}

---

POST /api/fleet/{id}/invest/

Description

View of a fleet.

Query parameters: space: uuid of the space to filter on. space_containers (bool): If True, list endpoint returns fleets for each space (default = True).

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this fleet.

Response 200 OK

---

POST /api/fleet/{id}/withdraw/

Description

View of a fleet.

Query parameters: space: uuid of the space to filter on. space_containers (bool): If True, list endpoint returns fleets for each space (default = True).

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this fleet.

Response 200 OK

key

---

GET /api/key/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "name": "string",
        "prefix": "string",
        "permissions": [
            {
                "uuid": "2f08b03a-8c6e-412a-9186-3a3985134603",
                "permission_type": "string",
                "approved": true,
                "space": "string"
            }
        ],
        "is_master_key": true,
        "revoked": true,
        "description": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/NapseAPIKey"
    }
}

---

POST /api/key/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "166832b1-df46-4ac7-92a8-130ebcc1ddf5",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "cdc74846-1e6c-48cc-bbae-f3872b564899",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "f91c996c-a22d-4009-a52f-7f10ee13b9e2",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

Response 201 Created

application/json

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "1dd365d1-e12f-40dc-95d7-78ba9f3b0d83",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

---

GET /api/key/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	string		No	A unique value identifying this API key.

Response 200 OK

application/json

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "3b8ca3d3-0f6b-44f3-980a-7780c1bca27e",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

---

DELETE /api/key/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	string		No	A unique value identifying this API key.

Response 204 No Content

---

GET /api/key/connect/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "492bcb16-4a53-4592-a76c-067b0f6805fc",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

---

GET /api/key/possible_permissions/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

{
    "name": "string",
    "prefix": "string",
    "permissions": [
        {
            "uuid": "7a2bd8a5-4c3a-40d8-8d58-4b4445a564b4",
            "permission_type": "string",
            "approved": true,
            "space": "string"
        }
    ],
    "is_master_key": true,
    "revoked": true,
    "description": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "A free-form name for the API key. Need not be unique. 50 characters max.",
            "maxLength": 50
        },
        "prefix": {
            "type": "string",
            "readOnly": true
        },
        "permissions": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Permission"
            },
            "readOnly": true
        },
        "is_master_key": {
            "type": "boolean"
        },
        "revoked": {
            "type": "boolean",
            "description": "If the API key is revoked, clients cannot use it anymore. (This cannot be undone.)"
        },
        "description": {
            "type": "string"
        }
    },
    "required": [
        "permissions",
        "prefix"
    ]
}

order

---

GET /api/order/

Description

For test & debug purposes only.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "side": "string",
        "completed": true,
        "spent": "string",
        "received": "string",
        "fees": "string",
        "created_at": "2022-04-13T15:42:05.901Z"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Order"
    }
}

space

---

GET /api/space/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Response 200 OK

application/json

[
    {
        "name": "string",
        "description": "string",
        "exchange_account": "string",
        "uuid": "0af8d2f9-8ee9-4ef6-856e-ddc8378df166",
        "testing": true,
        "value": 10.12,
        "delta": 10.12
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Space"
    }
}

---

POST /api/space/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "ac60faa0-fbaf-4fdd-ac6e-ed5cd89c5483",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "a1393f31-1dd4-4a17-90fb-160bb3b949c6",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "1cac7c78-bf2e-4e0a-a91a-35772df3b933",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

Response 201 Created

application/json

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "bfc284c7-0ea1-487d-bfee-16c1741406b1",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

---

GET /api/space/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "uuid": "b2470dd3-aa70-4b83-a417-52d2ee8e7661",
    "testing": true,
    "exchange_account": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "statistics": {},
    "wallet": null,
    "history": [
        null
    ],
    "fleets": [
        {
            "name": "string",
            "clusters": [
                {
                    "template_bot": "4842e528-d984-46a3-acd5-699ed01cb3c3",
                    "share": 10.12,
                    "breakpoint": 0,
                    "autoscale": true
                }
            ],
            "space": "073d7325-ed09-46df-86ab-40c682e53191",
            "uuid": "b088f0a8-6ab1-411c-9152-411ca3dc3347",
            "value": "string",
            "bot_count": "string",
            "delta": 10.12,
            "exchange_account": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "exchange_account": {
            "type": "string",
            "readOnly": true
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "readOnly": true
        },
        "statistics": {
            "type": "object",
            "additionalProperties": {},
            "readOnly": true
        },
        "wallet": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/Wallet"
                }
            ],
            "readOnly": true
        },
        "history": {
            "type": "array",
            "items": {},
            "readOnly": true
        },
        "fleets": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Fleet"
            },
            "readOnly": true
        }
    },
    "required": [
        "created_at",
        "description",
        "exchange_account",
        "fleets",
        "history",
        "name",
        "statistics",
        "testing",
        "uuid",
        "wallet"
    ]
}

---

PUT /api/space/{id}/

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "05bcd061-05eb-47eb-896c-582f8356f24e",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "a0d13933-afaa-4f0a-9fbe-52683a5003e1",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "fa95e9d4-8447-47ea-8313-bf89cafac416",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "e6a1f8b2-af61-495b-afb9-2e24ce0b8ebc",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

---

PATCH /api/space/{id}/

Description

Partial update the connected user.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Request body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "2a31a252-3e47-492d-8142-dc422b72a58f",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    }
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "013524ac-06eb-4063-b2c0-678691d3ccf2",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    }
}

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "2000c4e0-74b4-4d34-84fc-b20e70bf28d5",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    }
}

Response 200 OK

application/json

{
    "name": "string",
    "description": "string",
    "exchange_account": "string",
    "uuid": "94ea3e68-30c4-459c-bc1d-6e3ca6035d70",
    "testing": true,
    "value": 10.12,
    "delta": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "maxLength": 200
        },
        "description": {
            "type": "string"
        },
        "exchange_account": {
            "type": "string"
        },
        "uuid": {
            "type": "string",
            "format": "uuid",
            "readOnly": true
        },
        "testing": {
            "type": "boolean",
            "description": "Testing property.",
            "readOnly": true
        },
        "value": {
            "type": "number",
            "format": "double",
            "description": "Value market of space's wallet.",
            "readOnly": true
        },
        "delta": {
            "type": "number",
            "format": "double",
            "description": "Delta on the last 30 days.",
            "readOnly": true
        }
    },
    "required": [
        "delta",
        "description",
        "exchange_account",
        "name",
        "testing",
        "uuid",
        "value"
    ]
}

---

GET /api/space/{id}/invest/

Description

Endpoint to invest on space.

GET: Return all {ticker: amount} which can be invested in the space. POST: Invest in the space.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Response 200 OK

---

POST /api/space/{id}/invest/

Description

Endpoint to invest on space.

GET: Return all {ticker: amount} which can be invested in the space. POST: Invest in the space.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Response 200 OK

---

GET /api/space/{id}/withdraw/

Description

Endpoint to withdraw on space.

GET: Return all {ticker: amount} which can be withdrawn in the space. POST: Withdraw from the space.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Response 200 OK

---

POST /api/space/{id}/withdraw/

Description

Endpoint to withdraw on space.

GET: Return all {ticker: amount} which can be withdrawn in the space. POST: Withdraw from the space.

Input parameters

Parameter	In	Type	Default	Nullable	Description
basicAuth	header	string	N/A	No	Basic authentication
cookieAuth	cookie	string	N/A	No	API key
id	path	integer		No	A unique integer value identifying this napse space.

Response 200 OK

---

Schemas

Bot

Name	Type
delta	number(double)
exchange_account	string(uuid)| null
fleet	string
name	string
space	string(uuid)| null
uuid	string(uuid)
value	number(double)

BotDetail

Name	Type
delta	number(double)
exchange_account	string
fleet	string
name	string
orders	string
space	string(uuid)| null
statistics
uuid	string(uuid)
value	number(double)
wallet	string

ClusterFormatter

Name	Type
autoscale	boolean
breakpoint	integer
share	number(double)
template_bot	string(uuid)

Currency

Name	Type
amount	number(double)
mbp	number(double)
ticker	string
value	string

ExchangeAccount

Name	Type
description	string
exchange	string
name	string
testing	boolean
uuid	string(uuid)

ExchangeAccountDetail

Name	Type
created_at	string(date-time)
description	string
exchange	string
name	string
spaces	Array<Space>
testing	boolean
uuid	string(uuid)

Fleet

Name	Type
bot_count	string
clusters	Array<ClusterFormatter>
delta	number(double)
exchange_account	string
name	string
space	string(uuid)
uuid	string(uuid)
value	string

FleetDetail

Name	Type
bots	Array<Bot>
created_at	string(date-time)
exchange_account	integer
name	string
statistics	string
uuid	string(uuid)
wallet	string

NapseAPIKey

Name	Type
description	string
is_master_key	boolean
name	string
permissions	Array<Permission>
prefix	string
revoked	boolean

Order

Name	Type
completed	boolean
created_at	string(date-time)
fees	string
received	string
side	string
spent	string

PatchedSpace

Name	Type
delta	number(double)
description	string
exchange_account	string
name	string
testing	boolean
uuid	string(uuid)
value	number(double)

Permission

Name	Type
approved	boolean
permission_type	string
space	string
uuid	string(uuid)

Space

Name	Type
delta	number(double)
description	string
exchange_account	string
name	string
testing	boolean
uuid	string(uuid)
value	number(double)

SpaceDetail

Name	Type
created_at	string(date-time)
description	string
exchange_account	string
fleets	Array<Fleet>
history	Array<>
name	string
statistics
testing	boolean
uuid	string(uuid)
wallet

Wallet

Name	Type
created_at	string(date-time)
currencies	Array<Currency>
operations
title	string
value	number(double)

Security schemes

Name	Type	Scheme	Description
basicAuth	http	basic
cookieAuth	apiKey