samples.v1.2.bitdango-exchanges.json Maven / Gradle / Ivy
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
"basePath": "https://bitdango.com/api",
"resourcePath": "/exchanges",
"produces": [
"application/json"
],
"apis": [
{
"path": "/exchanges",
"operations": [
{
"nickname": "exchanges",
"method": "GET",
"summary": "Use this to search exchanges.",
"responseMessages": [
{
"code": 200,
"message": "Success Everything worked as expected."
},
{
"code": 500,
"message": "Error Generic error message."
},
{
"code": 503,
"message": "RequestThresholdBreached You may get this error if you are making too many requests in a time period."
}
],
"parameters": [
{
"defaultValue": "1",
"name": "page",
"description": "\r\n
\r\n",
"required": false,
"type": "integer",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": "10",
"name": "pageSize",
"description": "\r\n
\r\n",
"required": false,
"type": "integer",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": "False",
"name": "includeTotalResults",
"description": "\r\n
\r\n",
"required": false,
"type": "boolean",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": null,
"name": "exchanges",
"description": "\r\n- Example: coinbase, mtgox
\r\n
\r\n",
"required": false,
"type": "string",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": null,
"name": "countries",
"description": "\r\n- Example: AU, DE, US
\r\n
\r\n",
"required": false,
"type": "string",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": null,
"name": "facets",
"description": "- Example: countries, depositMethods, withdrawlMethods
",
"required": false,
"type": "string",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
},
{
"defaultValue": null,
"name": "expands",
"description": "- Example: limits, credentials, transferPolicies, markets
",
"required": false,
"type": "string",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
}
],
"notes": "Use this to search exchanges.
\r\nAuthentication Level = 0 (\r\npublic / no authentication\r\n)
\r\nFacet Codes
\r\nCode Description \r\ncountries Include a facet of the countries of exchanges. \r\ndepositMethods Include a facet of methods for depositing currency into an exchange. \r\nwithdrawlMethods Include a facet of methods for withdrawing currency from an exchange. \r\n
\r\nExpand Codes
\r\nCode Description \r\nlimits Include the limits enforced by this exchange. \r\ncredentials Include the credentials required to authenticate with this exchange. \r\ntransferPolicies Include the transfer policies enforced by this exchange. \r\nmarkets Include the markets listed on this exchange. \r\n
\r\n",
"type": null
}
]
},
{
"path": "/exchanges",
"operations": []
},
{
"path": "/exchanges/{exchangeCode}",
"operations": [
{
"nickname": "exchanges",
"method": "GET",
"summary": "Use this to get a specific exchange.",
"responseMessages": [
{
"code": 200,
"message": "Success Everything worked as expected."
},
{
"code": 404,
"message": "InvalidResource The resource you requested doesn't exist."
},
{
"code": 500,
"message": "Error Generic error message."
},
{
"code": 503,
"message": "RequestThresholdBreached You may get this error if you are making too many requests in a time period."
}
],
"parameters": [
{
"defaultValue": null,
"name": "exchangeCode",
"description": "\r\n
\r\n",
"required": true,
"type": "string",
"format": null,
"paramType": "path",
"minimum": null,
"maximum": null
},
{
"defaultValue": null,
"name": "expands",
"description": "- Example: markets, credentials, transferPolicies, limits
",
"required": false,
"type": "string",
"format": null,
"paramType": "query",
"minimum": null,
"maximum": null
}
],
"notes": "Use this to get a specific exchange.
\r\nAuthentication Level = 0 (\r\npublic / no authentication\r\n)
\r\nExpand Codes
\r\nCode Description \r\nmarkets Include the markets listed on this exchange. \r\ncredentials Include the credentials required to authenticate with this exchange. \r\ntransferPolicies Include the transfer policies enforced by this exchange. \r\nlimits Include the limits enforced by this exchange. \r\n
\r\n",
"type": null
}
]
}
],
"models": []
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy