Open311 (Prod)
This API exposes service requests submitted to the City of Philadelphia through the Philly311 mobile app.
NOTE - The Philly 311 API is currently read only - we only implement API methods that allow a client to retrieve information libraries service types or service requests. Allowing the creation of new service requests through this API is a feature that is on our roadmap for future releases.
API Keys
An API key is required for making requests to this API.
Registered users may request API keys and receive them instantly. Log in or register to request and manage API keys.
Paths
/services
get /services
Get a list of 311 service request types and their associated service codes.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
jurisdiction_id |
query | The location of the services , e.g. "philadelphia-pa" |
✓ | string |
| Code | Description | Schema | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | An array of services |
[array] | |||||||||
| default | unexpected error |
|
/services/{service_code}
get /services/{service_code}
Get details associated with a service code. (This call is only necessary if the service selected has metadata set as 'true' from the Get Services List response.)
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
service_code |
path | The service_code of a specific service. |
✓ | integer |
jurisdiction_id |
query | The location of the services , e.g. "philadelphia-pa" |
✓ | string |
| Code | Description | Schema | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | An array of services |
[array] | |||||||||
| default | unexpected error |
|
/requests
get /requests
Find out the current status of multiple service requests.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
jurisdiction_id |
query | The location of the service requests , e.g. "philadelphia-pa" |
✓ | string |
| Code | Description | Schema | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | An array of service requests |
[array] | |||||||||
| default | unexpected error |
|
/requests/{service_request_id}
get /requests/{service_request_id}
Find out the current status of an individual service request.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
service_request_id |
path | The ID of the service request |
✓ | string |
jurisdiction_id |
query | The location of the service request , e.g. "philadelphia-pa" |
✓ | string |
| Code | Description | Schema | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 200 | An array of services |
[array] | |||||||||
| default | unexpected error |
|
Models
| Name | Required | Schema |
|---|---|---|
code |
✓ | integer (int32) |
message |
✓ | string |
