NYC Survivor Support serves to support and empower victims of domestic violence living in New York City by providing easy access to educational, physical, and legal resources. We aim to assist our users by guiding survivors through the complexities of the legal system, offering immediate physical support through shelters and counseling services, and fostering awareness and prevention through educational initiatives and statistics. We are dedicated to creating a platform that not only promotes a safe healing process for survivors, but also equips others with the skills and knowledge needed to offer effective support to victims in their life.
\nNYC Survivor Support also provides an API that can be easily used to build your own platform using our data and services. This documentation details the use of our API and guides a new user through the complexities and pitfalls.
\nIn order to use the NYC Survivor Support API, the following must be done.
\nYou must use a valid API Key to send requests to the API endpoints. You can get your API key from nycsurvivorsupport.me.
\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\nReturns all the legal resources available in New York City to assist survivors of domestic violence.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}},"urlObject":{"path":["legal","collection"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Ascending/descending name-based ordering
\n","type":"text/plain"},"key":"name_order","value":"asc"},{"disabled":true,"description":{"content":"Borough resource is located in
\n","type":"text/plain"},"key":"borough","value":"Manhattan"},{"disabled":true,"description":{"content":"Whether resource is faith-based
\n","type":"text/plain"},"key":"faith_based","value":"true"},{"disabled":true,"description":{"content":"Whether resource is nonprofit
\n","type":"text/plain"},"key":"nonprofit","value":"false"},{"disabled":true,"description":{"content":"Whether resource is child-friendly
\n","type":"text/plain"},"key":"child_friendly","value":"false"},{"disabled":true,"description":{"content":"Whether resource is LGBTQ-specialized
\n","type":"text/plain"},"key":"lgbtq_specialized","value":"true"}],"variable":[]}},"response":[{"id":"c43593d1-8ee8-423f-a18e-e5451fe0076b","name":"Get all legal resources","originalRequest":{"method":"GET","header":[],"url":"/legal/resources"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"legal\",\n \"response_uuid\": \"4ad82de0-b200-4560-95d3-f74fabc86df1\",\n \"resources\": [\n {\n \"id\": 0,\n \"name\": \"Anderson Law Associates\",\n \"address\": \"1600 Hall St, Brooklyn, NY, 94001\",\n \"borough\": \"Brooklyn\",\n \"description\": \"\",\n \"languages\": [\"English\", \"Spanish\"]\n },\n {\n \"id\": 1,\n \"name\": \"5th Avenue Lawyers\",\n \"address\": \"83292 5th Ave, Manhattan, NY, 94001\",\n \"borough\": \"Manhattan\",\n \"description\": \"\",\n \"languages\": [\"English\", \"Chinese\"]\n }\n ]\n}\n"}],"_postman_id":"82689d4b-4e42-4e4e-af4c-556a960dcd06"},{"name":"Get a legal resource","event":[{"listen":"test","script":{"id":"805c668a-024b-413a-aa86-920bb4c7cdfe","exec":["pm.test(\"Test Legal Resource\", () => {"," pm.response.to.have.status(200)"," pm.response.to.be.ok"," pm.response.to.be.json"," response = pm.response.json()"," pm.expect(response.type).to.equal(\"LegalResource\")"," pm.expect(response.resource.id).to.equal(0)"," pm.expect(response.associations).to.haveOwnProperty(\"educational\")"," pm.expect(response.associations).to.haveOwnProperty(\"physical\")","})",""],"type":"text/javascript"}}],"id":"a1d04b88-c81e-4e62-b9e8-342413d7813c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/legal/resource?id=0","description":"Returns a particular legal resource that can be identified with an id.
This section provides details on accessing the legal resources in New York City that can assist survivors of domestic violence.
\n","_postman_id":"9fed7843-2058-4bcc-ac7b-d544404c8420","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}}},{"name":"Physical","item":[{"name":"Get all physical resources","event":[{"listen":"test","script":{"id":"4e339e78-539d-4785-87e7-9849d49cddbf","exec":["pm.test(\"Test Physical Collection\", () => {"," pm.response.to.have.status(200)"," pm.response.to.be.ok"," pm.response.to.be.json"," response = pm.response.json()"," pm.expect(response.type).to.equal(\"PhysicalResourceCollection\")"," pm.expect(response.resources.length).to.be.above(0)"," pm.expect(response.resources[0]).to.haveOwnProperty(\"id\")","})",""],"type":"text/javascript","packages":{}}}],"id":"a02e7433-06bf-4b48-b8b4-e77c69ed128d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/physical/collection","description":"Returns all the physical resources available in New York City to assist survivors of domestic violence.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}},"urlObject":{"path":["physical","collection"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Ascending/descending name-based ordering
\n","type":"text/plain"},"key":"name_order","value":"desc"},{"disabled":true,"description":{"content":"Borough resource is located in
\n","type":"text/plain"},"key":"borough","value":"Manhattan"},{"disabled":true,"description":{"content":"Whether resource has wheelchair access
\n","type":"text/plain"},"key":"wheelchair_access","value":"true"},{"disabled":true,"description":{"content":"Supported language
\n","type":"text/plain"},"key":"language_svcs","value":"Spanish"},{"disabled":true,"description":{"content":"Whether resource is child-friendly
\n","type":"text/plain"},"key":"child_friendly","value":"true"},{"disabled":true,"description":{"content":"Whether resource is LGBTQ-friendly
\n","type":"text/plain"},"key":"lgbtq_specialized","value":"false"}],"variable":[]}},"response":[{"id":"58a3d689-6446-4adb-9524-c79541c80d36","name":"Get all physical resources","originalRequest":{"method":"GET","header":[],"url":"/physical/resources"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"physical\",\n \"response_uuid\": \"4ad82de0-b200-4560-95d3-f74fabc86df1\",\n \"resources\": [\n {\n \"id\": 0,\n \"name\": \"5th Ave Presbyterian Church\",\n \"address\": \"1600 Hall St, Manhattan, NY, 94001\",\n \"borough\": \"Manhattan\",\n \"description\": \"\",\n \"languages\": [\n \"English\",\n \"Spanish\"\n ],\n \"faith-based\": true\n },\n {\n \"id\": 1,\n \"name\": \"Williamsburg Food Shelter\",\n \"address\": \"83292 Mary Ave, Brooklyn, NY, 98201\",\n \"borough\": \"Brooklyn\",\n \"description\": \"\",\n \"languages\": [\n \"English\",\n \"Chinese\"\n ],\n \"faith-based\": false\n }\n ]\n}"}],"_postman_id":"a02e7433-06bf-4b48-b8b4-e77c69ed128d"},{"name":"Get a physical resource","event":[{"listen":"test","script":{"id":"0ee54d4c-8299-4dae-a21e-0dc9a3d99c71","exec":["pm.test(\"Test Physical Resource\", () => {"," pm.response.to.have.status(200)"," pm.response.to.be.ok"," pm.response.to.be.json"," response = pm.response.json()"," pm.expect(response.type).to.equal(\"PhysicalResource\")"," pm.expect(response.resource.id).to.equal(0)"," pm.expect(response.associations).to.haveOwnProperty(\"educational\")"," pm.expect(response.associations).to.haveOwnProperty(\"legal\")","})",""],"type":"text/javascript"}}],"id":"b4065f12-f200-44b3-af4e-a65918bc1437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/physical/resource?id=0","description":"Returns a particular physical resource that can be identified with an id.
This section provides details on accessing the physical resources in New York City that can assist survivors of domestic violence including shelters and food pantries.
\n","_postman_id":"6477d1f7-e402-4dcb-80b3-d4fbc66ab177","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}}},{"name":"Educational","item":[{"name":"Get all educational resources","event":[{"listen":"test","script":{"id":"89e9b1b9-bc82-48f5-b7c3-6d44977e0dfd","exec":["pm.test(\"Test Educational Collection\", () => {"," pm.response.to.have.status(200)"," pm.response.to.be.ok"," pm.response.to.be.json"," response = pm.response.json()"," pm.expect(response.type).to.equal(\"EducationalResourceCollection\")"," pm.expect(response.resources.length).to.be.above(0)"," pm.expect(response.resources[0]).to.haveOwnProperty(\"id\")","})",""],"type":"text/javascript","packages":{}}}],"id":"601089c2-49bf-4b0f-b703-a0e12c278bcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/educational/collection","description":"Returns all the educational resources available in New York City to assist survivors of domestic violence.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}},"urlObject":{"path":["educational","collection"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"Ascending/descending name-based ordering
\n","type":"text/plain"},"key":"name_order","value":"asc"},{"disabled":true,"description":{"content":"Borough resource is located in
\n","type":"text/plain"},"key":"borough","value":"Manhattan"},{"disabled":true,"description":{"content":"Whether resource is faith-based
\n","type":"text/plain"},"key":"faith_based","value":"true"},{"disabled":true,"description":{"content":"Whether resource is nonprofit
\n","type":"text/plain"},"key":"nonprofit","value":"false"},{"disabled":true,"description":{"content":"Whether resource is child-friendly
\n","type":"text/plain"},"key":"child_friendly","value":"false"},{"disabled":true,"description":{"content":"Whether resource is LGBTQ-specialized
\n","type":"text/plain"},"key":"lgbtq_specialized","value":"true"}],"variable":[]}},"response":[{"id":"cb116f38-be2e-4775-9b83-dc9e84f70482","name":"Get all educational resources","originalRequest":{"method":"GET","header":[],"url":"/educational/resources"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"educational\",\n \"response_uuid\": \"4ad82de0-b200-4560-95d3-f74fabc86df1\",\n \"resources\": [\n {\n \"id\": 0,\n \"name\": \"Center for Domestic Violence Prevention and Awareness\",\n \"address\": \"1600 Hall St, Brooklyn, NY, 94001\",\n \"borough\": \"Brooklyn\",\n \"description\": \"\",\n \"languages\": [\n \"English\",\n \"Spanish\"\n ]\n },\n {\n \"id\": 1,\n \"name\": \"Urban Resource Institute\",\n \"address\": \"83292 5th Ave, Manhattan, NY, 94001\",\n \"borough\": \"Manhattan\",\n \"description\": \"\",\n \"languages\": [\n \"English\",\n \"Chinese\"\n ]\n }\n ]\n}"}],"_postman_id":"601089c2-49bf-4b0f-b703-a0e12c278bcb"},{"name":"Get an educational resource","event":[{"listen":"test","script":{"id":"266af91f-0655-4cf9-bf1c-7f0fbed3ad71","exec":["pm.test(\"Test Educational Resource\", () => {"," pm.response.to.have.status(200)"," pm.response.to.be.ok"," pm.response.to.be.json"," response = pm.response.json()"," pm.expect(response.type).to.equal(\"EducationalResource\")"," pm.expect(response.resource.id).to.equal(0)"," pm.expect(response.associations).to.haveOwnProperty(\"physical\")"," pm.expect(response.associations).to.haveOwnProperty(\"legal\")","})",""],"type":"text/javascript"}}],"id":"59ed2b1e-7bfd-44c5-adbb-12dfcc6ccae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/educational/resource?id=0","description":"Returns a particular educational resource that can be identified with an id.
This section provides details on accessing the educational resources in New York City that can assist survivors of domestic violence including prevention and awareness centers.
\n","_postman_id":"bbc4e92b-ee5b-4147-8da0-9585e749537b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"36b15b16-c3b5-4262-822c-2f8ce767c993","id":"36b15b16-c3b5-4262-822c-2f8ce767c993","name":"API Documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"dc6dd790-e1bc-48da-8fba-eb3fa3f42ebb","key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}