{"_id":"55947b9d35f5671700942e7f","__v":11,"project":"543de77431ca981a00a700ec","version":{"_id":"55819c76a5474a0d00d945db","__v":6,"project":"543de77431ca981a00a700ec","forked_from":"543de77431ca981a00a700ef","createdAt":"2015-06-17T16:12:38.031Z","releaseDate":"2015-06-17T16:12:38.031Z","categories":["55819c76a5474a0d00d945dc","55883498b3bcf52b00513212","5591ad23c671980d00543dd7","5591adfa342e980d006db03b","5591ae005781ae0d00236737","5595b4c4f4437019002888fb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5591ae005781ae0d00236737","__v":9,"pages":["5593165847f40b1700360786","55946c610c33bd0d0005968c","5594749535f5671700942e6b","55947b960c33bd0d000596b7","55947b9d35f5671700942e7f","55947ba90c33bd0d000596b9","559484b70c33bd0d000596d0","559496bc0c33bd0d000596ec","559d7a7979e08b350041b8f3"],"version":"55819c76a5474a0d00d945db","project":"543de77431ca981a00a700ec","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-29T20:43:44.229Z","from_sync":false,"order":2,"slug":"methods","title":"Methods"},"user":"557b54fb9670ce0d0071b7bd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-01T23:45:33.973Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"The filters endpoint will show you what parameters you can use as filters in your query.\n\nThere are two types of categories of filters:\n  * Risk Bands\n  * Terms\n\n\nYou can also use more than one filter by using the '&' operator. See 'Daisy Chaining Filters' below for more information.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/trGT8tXSTJGPMX3r7N5g_Blank%20Flowchart%20-%20Filters.png\",\n        \"Blank Flowchart - Filters.png\",\n        \"1013\",\n        \"788\",\n        \"\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://investor-api.fundingcircle.us/api/v2/filters\\n\\n{\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"https://investor-api.fundingcircle.us/api/v2/filters\\\"\\n        },\\n        \\\"risk_bands\\\": {\\n            \\\"href\\\": \\\"https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\\\"\\n        },\\n        \\\"terms\\\": {\\n            \\\"href\\\": \\\"https://investor-api.fundingcircle.us/api/v2/filters/terms\\\"\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nYou can use this filter as part of a listings call by using the following:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://investor-api.fundingcircle.us/api/v2/filters&risk_bands[]=\\\"B\\\"\\nGET https://investor-api.fundingcircle.us/api/v2/filters$terms[]=48\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Risk Bands\"\n}\n[/block]\nThis endpoint will show you all of the available risk bands that Funding Circle supports. You can use this to filter the loans that appear in your /listings call.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\\n\\n{\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\\\"\\n        }\\n    },\\n    \\\"risk_bands\\\": [\\n        \\\"A+\\\",\\n        \\\"A\\\",\\n        \\\"B\\\",\\n        \\\"C\\\",\\n        \\\"D\\\"\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Using URL Formatting\",\n  \"body\": \"Remember that you will need to encode your API call for certain symbols. In this case, you may want to get a list of loans that are \\\"A+\\\". Use the '%2B ' encoding for the '+' symbol in your call ( /listings&risk_bands[]=\\\"A%2B\\\")\"\n}\n[/block]\nYou can also string risk bands together to get more than one result:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET  https://investor-api.fundingcircle.us/api/v2/listings?risk_bands[]=A&risk_bands[]=B\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Terms\"\n}\n[/block]\nThis endpoint will show you all of the terms (in months) that Funding Circle supports.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://investor-api.fundingcircle.us/api/v2/filters/terms\\n\\n{\\n    \\\"_links\\\": {\\n        \\\"self\\\": {\\n            \\\"href\\\": \\\"https://us-investor-api.fundingcircle.us/v2/filters/terms\\\"\\n        }\\n    },\\n    \\\"terms\\\": [\\n        12,\\n        24,\\n        36,\\n        48,\\n        60\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nJust like the risk bands you can string together multiple terms.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET  https://investor-api.fundingcircle.us/api/v2/listings?terms[]=48&terms[]=24\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Daisy Chaining Filters\"\n}\n[/block]\nYou can search for multiple risk bands or terms (or both) by daisy chaining the filters together. For example the following will give you all listings that are rated A or B, and are also either 12 or 24 month terms:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://investor-api.fundingcircle.us/api/v2/listings?risk_bands[]=A&risk_bands[]=B&terms[]=12&terms=[]24\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"get-filters","type":"basic","title":"GET Filters"}
The filters endpoint will show you what parameters you can use as filters in your query. There are two types of categories of filters: * Risk Bands * Terms You can also use more than one filter by using the '&' operator. See 'Daisy Chaining Filters' below for more information. [block:image] { "images": [ { "image": [ "https://files.readme.io/trGT8tXSTJGPMX3r7N5g_Blank%20Flowchart%20-%20Filters.png", "Blank Flowchart - Filters.png", "1013", "788", "", "" ] } ] } [/block] [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/filters\n\n{\n \"_links\": {\n \"self\": {\n \"href\": \"https://investor-api.fundingcircle.us/api/v2/filters\"\n },\n \"risk_bands\": {\n \"href\": \"https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\"\n },\n \"terms\": {\n \"href\": \"https://investor-api.fundingcircle.us/api/v2/filters/terms\"\n }\n }\n}", "language": "json" } ] } [/block] You can use this filter as part of a listings call by using the following: [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/filters&risk_bands[]=\"B\"\nGET https://investor-api.fundingcircle.us/api/v2/filters$terms[]=48", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Risk Bands" } [/block] This endpoint will show you all of the available risk bands that Funding Circle supports. You can use this to filter the loans that appear in your /listings call. [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\n\n{\n \"_links\": {\n \"self\": {\n \"href\": \"https://investor-api.fundingcircle.us/api/v2/filters/risk_bands\"\n }\n },\n \"risk_bands\": [\n \"A+\",\n \"A\",\n \"B\",\n \"C\",\n \"D\"\n ]\n}", "language": "json" } ] } [/block] [block:callout] { "type": "warning", "title": "Using URL Formatting", "body": "Remember that you will need to encode your API call for certain symbols. In this case, you may want to get a list of loans that are \"A+\". Use the '%2B ' encoding for the '+' symbol in your call ( /listings&risk_bands[]=\"A%2B\")" } [/block] You can also string risk bands together to get more than one result: [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/listings?risk_bands[]=A&risk_bands[]=B", "language": "text" } ] } [/block] [block:api-header] { "type": "basic", "title": "Terms" } [/block] This endpoint will show you all of the terms (in months) that Funding Circle supports. [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/filters/terms\n\n{\n \"_links\": {\n \"self\": {\n \"href\": \"https://us-investor-api.fundingcircle.us/v2/filters/terms\"\n }\n },\n \"terms\": [\n 12,\n 24,\n 36,\n 48,\n 60\n ]\n}", "language": "json" } ] } [/block] Just like the risk bands you can string together multiple terms. [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/listings?terms[]=48&terms[]=24", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Daisy Chaining Filters" } [/block] You can search for multiple risk bands or terms (or both) by daisy chaining the filters together. For example the following will give you all listings that are rated A or B, and are also either 12 or 24 month terms: [block:code] { "codes": [ { "code": "GET https://investor-api.fundingcircle.us/api/v2/listings?risk_bands[]=A&risk_bands[]=B&terms[]=12&terms=[]24", "language": "json" } ] } [/block]