Skip to content

Commit 407db83

Browse files
hebron-georgeclaude
andcommitted
Update README with Transparency endpoint examples and fix stale links
- Add Transparency API to the endpoint list in the Usage section - Add a dedicated section with CRL-specific query examples - Fix [USERNAME] placeholder links in Contributing and Code of Conduct Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 0a993cc commit 407db83

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,40 @@ client.other.substance_data_reports(args)
6464

6565
# Tobacco API
6666
client.tobacco.problem_reports(args)
67+
68+
# Transparency API
69+
client.transparency.complete_response_letters(args)
70+
```
71+
72+
### Transparency — Complete Response Letters
73+
74+
Complete Response Letters (CRLs) are issued by the FDA when a New Drug Application (NDA)
75+
or Biologics License Application (BLA) cannot be approved in its current form.
76+
77+
```ruby
78+
client = OpenFdaApi::Client.new
79+
80+
# Fetch the most recent CRL
81+
client.transparency.complete_response_letters(limit: 1)
82+
83+
# Search by company name
84+
client.transparency.complete_response_letters(
85+
search: [{ "company_name" => "Pfizer" }],
86+
limit: 10
87+
)
88+
89+
# Search by approver center and sort by letter date descending
90+
client.transparency.complete_response_letters(
91+
search: [{ "approver_center" => "Center for Drug Evaluation and Research" }],
92+
sort: [{ "letter_date" => "desc" }],
93+
limit: 5
94+
)
95+
96+
# Search for CRLs from a specific company OR a specific approver
97+
client.transparency.complete_response_letters(
98+
search: [{ "company_name" => "Novartis" }, { "approver_name" => "John Doe" }],
99+
limit: 10
100+
)
67101
```
68102

69103
### Querying
@@ -116,12 +150,12 @@ To release a new version, update the version number in `version.rb`, and then ru
116150
## Contributing
117151

118152
Bug reports and pull requests are welcome on GitHub at https://github.com/hebron-george/open_fda_api .
119-
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/open_fda_api/blob/master/CODE_OF_CONDUCT.md).
153+
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hebron-george/open_fda_api/blob/main/CODE_OF_CONDUCT.md).
120154

121155
## License
122156

123157
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
124158

125159
## Code of Conduct
126160

127-
Everyone interacting in the OpenFdaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_fda_api/blob/master/CODE_OF_CONDUCT.md).
161+
Everyone interacting in the OpenFdaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hebron-george/open_fda_api/blob/main/CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)