Skip to content

Hexproof API 1.0.0

Servers

Description URL
Official production server for the Hexproof API. https://api.hexproof.io
Locally hosted django testing server. http://localhost:8000

Endpoints

GET /keys/{name}

Get Key

Description

Retrieve an API key that is currently active.

Args: request (HttpRequest): Django request object. name (str): Name of the key to look for.

Returns: APIKeySchema: An APIKey object if an active key was found, otherwise an error object with a reason code and readable message.

Input parameters

Parameter In Type Default Nullable Description
name path string No

Response 200 OK 

1
2
3
4
5
6
{
    "active": true,
    "key": "string",
    "name": "string",
    "permission": 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "description": "API object schema for API Keys.",
    "properties": {
        "active": {
            "title": "Active",
            "type": "boolean"
        },
        "key": {
            "title": "Key",
            "type": "string"
        },
        "name": {
            "title": "Name",
            "type": "string"
        },
        "permission": {
            "title": "Permission",
            "type": "integer"
        }
    },
    "required": [
        "name",
        "key",
        "active",
        "permission"
    ],
    "title": "APIKey",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /meta/

Get Meta All

Description

Retrieve a dictionary of all resource metas.

Args: request: HTTP request object.

Returns: dict: A dictionary of all Meta objects, with keys as 'resource' value.

Response 200 OK

Schema of the response body 
1
2
3
4
5
6
7
{
    "additionalProperties": {
        "$ref": "#/components/schemas/Meta"
    },
    "title": "Response",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /meta/{resource}

Get Meta

Description

Retrieve a dictionary of all resource metas.

Args: request: HTTP request object. resource: Specific 'Meta' resource to look for.

Returns: MetaSchema: A specific MetaSchema object matching a resource value.

Input parameters

Parameter In Type Default Nullable Description
resource path string No

Response 200 OK 

1
2
3
4
5
{
    "date": "string",
    "uri": "string",
    "version": "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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "properties": {
        "date": {
            "title": "Date",
            "type": "string"
        },
        "uri": {
            "title": "Uri",
            "type": "string"
        },
        "version": {
            "title": "Version",
            "type": "string"
        }
    },
    "required": [
        "date",
        "version",
        "uri"
    ],
    "title": "Meta",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /sets/

All Sets

Description

Returns a dictionary of data objects for all sets by code.

Response 200 OK

Schema of the response body 
1
2
3
4
5
6
7
{
    "additionalProperties": {
        "$ref": "#/components/schemas/Set"
    },
    "title": "Response",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /sets/{code}

Get Set

Description

Returns a data object for a specific set.

Input parameters

Parameter In Type Default Nullable Description
code path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
    "block": null,
    "block_code": null,
    "code": "string",
    "code_alt": null,
    "code_arena": null,
    "code_keyrune": null,
    "code_mtgo": null,
    "code_parent": null,
    "code_symbol": "string",
    "count_cards": 0,
    "count_printed": null,
    "count_tokens": 0,
    "date_released": "string",
    "flags": {
        "is_digital_only": true,
        "is_foil_only": true,
        "is_foreign_only": true,
        "is_nonfoil_only": true,
        "is_paper_only": true,
        "is_preview": true
    },
    "id": "string",
    "id_cardmarket": null,
    "id_cardmarket_extras": null,
    "id_cardsphere": null,
    "id_tcgplayer": null,
    "name": "string",
    "name_cardmarket": null,
    "type": "string",
    "uris_scryfall": {
        "icon": null,
        "object": null,
        "page": null,
        "parent": null,
        "search": null
    },
    "uris_symbol": {}
}
⚠️ 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 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
{
    "description": "Entire Set object as an API return schema.",
    "properties": {
        "block": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Block"
        },
        "block_code": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Block Code"
        },
        "code": {
            "title": "Code",
            "type": "string"
        },
        "code_alt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Code Alt"
        },
        "code_arena": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Code Arena"
        },
        "code_keyrune": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Code Keyrune"
        },
        "code_mtgo": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Code Mtgo"
        },
        "code_parent": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Code Parent"
        },
        "code_symbol": {
            "title": "Code Symbol",
            "type": "string"
        },
        "count_cards": {
            "title": "Count Cards",
            "type": "integer"
        },
        "count_printed": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Count Printed"
        },
        "count_tokens": {
            "title": "Count Tokens",
            "type": "integer"
        },
        "date_released": {
            "title": "Date Released",
            "type": "string"
        },
        "flags": {
            "$ref": "#/components/schemas/SetFlags"
        },
        "id": {
            "title": "Id",
            "type": "string"
        },
        "id_cardmarket": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Id Cardmarket"
        },
        "id_cardmarket_extras": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Id Cardmarket Extras"
        },
        "id_cardsphere": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Id Cardsphere"
        },
        "id_tcgplayer": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Id Tcgplayer"
        },
        "name": {
            "title": "Name",
            "type": "string"
        },
        "name_cardmarket": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Name Cardmarket"
        },
        "type": {
            "title": "Type",
            "type": "string"
        },
        "uris_scryfall": {
            "$ref": "#/components/schemas/SetURIScryfall"
        },
        "uris_symbol": {
            "additionalProperties": {
                "type": "string"
            },
            "title": "Uris Symbol",
            "type": "object"
        }
    },
    "required": [
        "block",
        "block_code",
        "code",
        "code_alt",
        "code_arena",
        "code_keyrune",
        "code_mtgo",
        "code_parent",
        "code_symbol",
        "count_cards",
        "count_printed",
        "count_tokens",
        "date_released",
        "flags",
        "id",
        "id_cardmarket",
        "id_cardmarket_extras",
        "id_cardsphere",
        "id_tcgplayer",
        "name",
        "name_cardmarket",
        "type",
        "uris_scryfall",
        "uris_symbol"
    ],
    "title": "Set",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/manifest/

Get Symbol Manifest

Description

Return the current symbol manifest from the mtg-vectors repository.

Args: request: HTTP request object.

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "meta": {
        "date": "string",
        "uri": "string",
        "version": "string"
    },
    "set": {
        "aliases": {},
        "rarities": {},
        "routes": {},
        "symbols": {}
    },
    "watermark": {
        "routes": {},
        "symbols": [
            "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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
    "properties": {
        "meta": {
            "$ref": "#/components/schemas/Meta"
        },
        "set": {
            "$ref": "#/components/schemas/SetSymbolManifest"
        },
        "watermark": {
            "$ref": "#/components/schemas/WatermarkSymbolManifest"
        }
    },
    "required": [
        "meta",
        "set",
        "watermark"
    ],
    "title": "Manifest",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/package/

Get Symbol Package Default

Description

Return the default symbol package from the mtg-vectors repository.

Args: request: HTTP request object.

Response 200 OK

GET /symbols/package/{name}

Get Symbol Package

Description

Return a specified symbol package from the mtg-vectors repository.

Args: request: HTTP request object. name: Name of the symbol package, options are "all" and "optimized".

Input parameters

Parameter In Type Default Nullable Description
name path string No

Response 200 OK

Schema of the response body 
1
2
3
{
    "title": "Response"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/rarity/

Get Symbol Rarities

Description

Return a dictionary of all set symbol rarities.

Args: request: HTTP request object.

Returns: A dictionary where keys are the rarity code, values are the name of the rarity.

Response 200 OK

Schema of the response body 
1
2
3
4
5
6
7
{
    "additionalProperties": {
        "type": "string"
    },
    "title": "Response",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/set/

Get Symbol Set All

Description

Return a dictionary of all set symbol collections.

Args: request: HTTP request object.

Returns: dict[str, SetSymbolURI]: A dictionary where keys are the symbol code, values are URI maps from 'SymbolSet' resources.

Response 200 OK

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "additionalProperties": {
        "additionalProperties": {
            "type": "string"
        },
        "type": "object"
    },
    "title": "Response",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/set/{code}

Get Symbol Set

Description

Returns a URI map for a 'SymbolSet' resource.

Args: request: HTTP request object. code: 'SymbolSet' identifier code or 'Set' identifier code.

Returns: SetSymbolURI: A URI map from a 'SymbolSet' object.

Input parameters

Parameter In Type Default Nullable Description
code path string No

Response 200 OK

Schema of the response body 
1
2
3
4
5
6
7
{
    "additionalProperties": {
        "type": "string"
    },
    "title": "Response",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/set/{code}/{rarity}

Get Symbol Set Rarity

Description

Returns a specific SVG set symbol asset with a given symbol or set code and rarity.

Args: request: HTTP request object. code: Symbol code the symbol is defined by, or code the parent set is defined by. rarity: The rarity version of the symbol to return.

Returns: FileResponse: The requested watermark SVG file asset.

Input parameters

Parameter In Type Default Nullable Description
code path string No
rarity path string No

Response 200 OK

Schema of the response body 
1
2
3
{
    "title": "Response"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/watermark/

Get Symbol Watermark All

Description

Return a dictionary of all watermark symbol URI's.

Args: request: HTTP request object.

Returns: WatermarkSymbolURI: A dictionary containing named watermarks and set symbol watermarks.

Response 200 OK 

1
2
3
4
{
    "watermarks": {},
    "watermarks_set": {}
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "description": "Endpoint URI's for all 'SymbolCollectionWatermark' objects.\nWatermarks divided into 'watermarks' and 'watermarks_set'.",
    "properties": {
        "watermarks": {
            "additionalProperties": {
                "type": "string"
            },
            "title": "Watermarks",
            "type": "object"
        },
        "watermarks_set": {
            "additionalProperties": {
                "type": "string"
            },
            "title": "Watermarks Set",
            "type": "object"
        }
    },
    "required": [
        "watermarks",
        "watermarks_set"
    ],
    "title": "WatermarkSymbolURI",
    "type": "object"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/watermark/set/{code}

Get Symbol Watermark Set

Description

Returns a watermark 'Set' symbol with a given set symbol code or set code.

Args: request: HTTP request object. code: Symbol code the symbol is defined by, or code the parent set is defined by.

Returns: FileResponse: The requested watermark SVG file asset.

Input parameters

Parameter In Type Default Nullable Description
code path string No

Response 200 OK

Schema of the response body 
1
2
3
{
    "title": "Response"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

GET /symbols/watermark/{name}

Get Symbol Watermark

Description

Returns a specific SVG watermark symbol asset with a given name.

Args: request: HTTP request object. name: Symbol name the symbol is defined by.

Returns: FileResponse: The requested watermark SVG file asset.

Input parameters

Parameter In Type Default Nullable Description
name path string No

Response 200 OK

Schema of the response body 
1
2
3
{
    "title": "Response"
}

Response 400 Bad Request 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 403 Forbidden 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 404 Not Found 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 405 Method Not Allowed 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 410 Gone 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 500 Internal Server Error 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 501 Not Implemented 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Response 502 Bad Gateway 

1
2
3
4
5
6
7
{
    "data": null,
    "details": "string",
    "object": "string",
    "status": null,
    "warnings": null
}
⚠️ 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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    "description": "Defines the object structure of an error response.",
    "properties": {
        "data": {
            "anyOf": [
                {
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Data"
        },
        "details": {
            "default": "Resource not found!",
            "title": "Details",
            "type": "string"
        },
        "object": {
            "default": "error",
            "title": "Object",
            "type": "string"
        },
        "status": {
            "allOf": [
                {
                    "$ref": "#/components/schemas/StatusCode"
                }
            ],
            "default": 404
        },
        "warnings": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Warnings"
        }
    },
    "title": "ErrorResponse",
    "type": "object"
}

Schemas

APIKey

Name Type
active boolean
key string
name string
permission integer

ErrorResponse

Name Type
data
details string
object string
status
warnings

Manifest

Name Type
meta Meta
set SetSymbolManifest
watermark WatermarkSymbolManifest

Meta

Name Type
date string
uri string
version string

Set

Name Type
block
block_code
code string
code_alt
code_arena
code_keyrune
code_mtgo
code_parent
code_symbol string
count_cards integer
count_printed
count_tokens integer
date_released string
flags SetFlags
id string
id_cardmarket
id_cardmarket_extras
id_cardsphere
id_tcgplayer
name string
name_cardmarket
type string
uris_scryfall SetURIScryfall
uris_symbol

SetFlags

Name Type
is_digital_only boolean
is_foil_only boolean
is_foreign_only boolean
is_nonfoil_only boolean
is_paper_only boolean
is_preview boolean

SetSymbolManifest

Name Type
aliases
rarities
routes
symbols

SetURIScryfall

Name Type
icon
object
page
parent
search

StatusCode

Type: integer

WatermarkSymbolManifest

Name Type
routes
symbols Array<string>

WatermarkSymbolURI

Name Type
watermarks
watermarks_set