{"_id":"59f79e3c584eb200345ceb84","parentDoc":null,"user":"54e4044e8ef7552300409dcb","version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":8,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293","5b9ed89212362100036b5a1c","5bb29bec77c22500034757ea","5bb29bfe77c22500034757ec","5bc8fa8063924c00186c5ded","5bc8fe9fa472190014a6b103"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"__v":0,"category":{"_id":"59f79e3c584eb200345ceb3a","__v":0,"project":"59f79e3c584eb200345ceafc","version":"59f79e3c584eb200345ceaff","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-18T03:20:58.779Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"project":"59f79e3c584eb200345ceafc","githubsync":"","updates":["56071f7b44789e0d0071211a","58d18b9c175dc22500e32882"],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T03:59:16.458Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"Following is a map of the entire API including all of the API calls that are supported and what you can do with each call.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"HTTP Verb\",\n    \"h-1\": \"URL\",\n    \"h-2\": \"Functionality\",\n    \"h-3\": \"Rate Limits (per min/per user)\",\n    \"2-0\": \"GET\",\n    \"2-1\": \"/users\",\n    \"2-2\": \"View all users created with your client keys (paginated).\",\n    \"2-3\": \"100\",\n    \"3-1\": \"/users\",\n    \"3-0\": \"POST\",\n    \"3-2\": \"Allows you to register a new user.\",\n    \"3-3\": \"100\",\n    \"4-0\": \"GET\",\n    \"4-1\": \"/users/<user:id>\",\n    \"4-2\": \"View user info and `refresh_token`.\",\n    \"4-3\": \"30\",\n    \"5-0\": \"PATCH\",\n    \"5-1\": \"/users/<user:id>\",\n    \"5-2\": \"Add/update KYC, log in credentials, profile, etc.\",\n    \"5-3\": \"30\",\n    \"6-0\": \"GET\",\n    \"6-1\": \"/users/<user:id>/nodes\",\n    \"6-2\": \"View all nodes linked to a user (paginated).\",\n    \"6-3\": \"100\",\n    \"7-0\": \"POST\",\n    \"7-1\": \"/users/<user:id>/nodes\",\n    \"7-2\": \"Allows you to create a deposit account or link an external bank account to a user.\",\n    \"8-0\": \"GET\",\n    \"8-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"8-2\": \"View node info.\",\n    \"9-0\": \"PATCH\",\n    \"9-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"9-2\": \"Update `supp_id`, verify micro-deposits, etc.\",\n    \"10-1\": \"/users/<user:id>/nodes/<node:id>\",\n    \"10-0\": \"DELETE\",\n    \"10-2\": \"Unindex node from a user.\",\n    \"10-3\": \"100\",\n    \"15-0\": \"GET\",\n    \"15-1\": \"/users/<user:id>/trans\",\n    \"15-2\": \"View all transactions of a user (paginated).\",\n    \"15-3\": \"100\",\n    \"17-0\": \"POST\",\n    \"17-1\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"17-2\": \"Allows you to create a transaction.\",\n    \"18-0\": \"GET\",\n    \"18-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"18-2\": \"View transaction info.\",\n    \"19-0\": \"PATCH\",\n    \"19-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"19-2\": \"Update notes on a transaction.\",\n    \"19-3\": \"100\",\n    \"20-0\": \"DELETE\",\n    \"20-1\": \"/users/<user:id>/nodes/<node:id>/trans/<trans:id>\",\n    \"20-2\": \"Only works if transaction has been created or queued.\",\n    \"20-3\": \"100\",\n    \"7-3\": \"100\",\n    \"8-3\": \"100\",\n    \"9-3\": \"100\",\n    \"17-3\": \"100\",\n    \"18-3\": \"100\",\n    \"0-0\": \"POST\",\n    \"0-1\": \"/oauth/<user:id>\",\n    \"0-2\": \"This API call allows you to get `oauth_key` for users.\",\n    \"0-3\": \"30\",\n    \"21-0\": \"GET\",\n    \"21-1\": \"/subscriptions\",\n    \"21-2\": \"View all subscriptions created with your client keys (paginated).\",\n    \"21-3\": \"10\",\n    \"22-0\": \"POST\",\n    \"22-1\": \"/subscriptions\",\n    \"22-2\": \"Create a subscription with webhook preferences.\",\n    \"22-3\": \"10\",\n    \"23-0\": \"GET\",\n    \"23-1\": \"/subscriptions/<subscription:id>\",\n    \"23-2\": \"View a subscription.\",\n    \"23-3\": \"10\",\n    \"24-0\": \"PATCH\",\n    \"24-1\": \"/subscriptions/<subscription:id>\",\n    \"24-2\": \"Update `scope`, `url`, `is_active`, etc.\",\n    \"24-3\": \"10\",\n    \"1-0\": \"POST\",\n    \"1-1\": \"/oauth/<user:id>/login\",\n    \"1-2\": \"Using basic auth to get `refresh_token` for users.\",\n    \"1-3\": \"30\",\n    \"16-0\": \"GET\",\n    \"16-1\": \"/users/<user:id>/nodes/<node:id>/trans\",\n    \"16-2\": \"View all transactions of a node (paginated).\",\n    \"16-3\": \"100\",\n    \"h-4\": \"Rate Limits (per min)\",\n    \"11-0\": \"POST\",\n    \"11-1\": \"/users/<user:id>/nodes/<node:id>/subnets\",\n    \"11-2\": \"Allows you to issue a virtual account number on top of a node.\",\n    \"11-3\": \"100\",\n    \"12-0\": \"GET\",\n    \"12-2\": \"View all subnets linked to a node (paginated).\",\n    \"12-1\": \"/users/<user:id>/nodes/<node:id>/subnets\",\n    \"12-3\": \"100\",\n    \"13-1\": \"/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>\",\n    \"13-2\": \"View subnet info.\",\n    \"13-3\": \"100\",\n    \"13-0\": \"GET\",\n    \"14-0\": \"PATCH\",\n    \"14-1\": \"/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>\",\n    \"14-3\": \"100\",\n    \"14-2\": \"Update subnet info.\"\n  },\n  \"cols\": 4,\n  \"rows\": 25\n}\n[/block]","excerpt":"Following is the Map of the API","slug":"api-map-and-rate-limits","type":"basic","title":"API Map and Rate Limits"}

API Map and Rate Limits

Following is the Map of the API

Following is a map of the entire API including all of the API calls that are supported and what you can do with each call. [block:parameters] { "data": { "h-0": "HTTP Verb", "h-1": "URL", "h-2": "Functionality", "h-3": "Rate Limits (per min/per user)", "2-0": "GET", "2-1": "/users", "2-2": "View all users created with your client keys (paginated).", "2-3": "100", "3-1": "/users", "3-0": "POST", "3-2": "Allows you to register a new user.", "3-3": "100", "4-0": "GET", "4-1": "/users/<user:id>", "4-2": "View user info and `refresh_token`.", "4-3": "30", "5-0": "PATCH", "5-1": "/users/<user:id>", "5-2": "Add/update KYC, log in credentials, profile, etc.", "5-3": "30", "6-0": "GET", "6-1": "/users/<user:id>/nodes", "6-2": "View all nodes linked to a user (paginated).", "6-3": "100", "7-0": "POST", "7-1": "/users/<user:id>/nodes", "7-2": "Allows you to create a deposit account or link an external bank account to a user.", "8-0": "GET", "8-1": "/users/<user:id>/nodes/<node:id>", "8-2": "View node info.", "9-0": "PATCH", "9-1": "/users/<user:id>/nodes/<node:id>", "9-2": "Update `supp_id`, verify micro-deposits, etc.", "10-1": "/users/<user:id>/nodes/<node:id>", "10-0": "DELETE", "10-2": "Unindex node from a user.", "10-3": "100", "15-0": "GET", "15-1": "/users/<user:id>/trans", "15-2": "View all transactions of a user (paginated).", "15-3": "100", "17-0": "POST", "17-1": "/users/<user:id>/nodes/<node:id>/trans", "17-2": "Allows you to create a transaction.", "18-0": "GET", "18-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "18-2": "View transaction info.", "19-0": "PATCH", "19-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "19-2": "Update notes on a transaction.", "19-3": "100", "20-0": "DELETE", "20-1": "/users/<user:id>/nodes/<node:id>/trans/<trans:id>", "20-2": "Only works if transaction has been created or queued.", "20-3": "100", "7-3": "100", "8-3": "100", "9-3": "100", "17-3": "100", "18-3": "100", "0-0": "POST", "0-1": "/oauth/<user:id>", "0-2": "This API call allows you to get `oauth_key` for users.", "0-3": "30", "21-0": "GET", "21-1": "/subscriptions", "21-2": "View all subscriptions created with your client keys (paginated).", "21-3": "10", "22-0": "POST", "22-1": "/subscriptions", "22-2": "Create a subscription with webhook preferences.", "22-3": "10", "23-0": "GET", "23-1": "/subscriptions/<subscription:id>", "23-2": "View a subscription.", "23-3": "10", "24-0": "PATCH", "24-1": "/subscriptions/<subscription:id>", "24-2": "Update `scope`, `url`, `is_active`, etc.", "24-3": "10", "1-0": "POST", "1-1": "/oauth/<user:id>/login", "1-2": "Using basic auth to get `refresh_token` for users.", "1-3": "30", "16-0": "GET", "16-1": "/users/<user:id>/nodes/<node:id>/trans", "16-2": "View all transactions of a node (paginated).", "16-3": "100", "h-4": "Rate Limits (per min)", "11-0": "POST", "11-1": "/users/<user:id>/nodes/<node:id>/subnets", "11-2": "Allows you to issue a virtual account number on top of a node.", "11-3": "100", "12-0": "GET", "12-2": "View all subnets linked to a node (paginated).", "12-1": "/users/<user:id>/nodes/<node:id>/subnets", "12-3": "100", "13-1": "/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>", "13-2": "View subnet info.", "13-3": "100", "13-0": "GET", "14-0": "PATCH", "14-1": "/users/<user:id>/nodes/<node:id>/subnets/<subnet:id>", "14-3": "100", "14-2": "Update subnet info." }, "cols": 4, "rows": 25 } [/block]