list_tickers() sorting behavior doesn't match documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
Research direction
Start at RESTClient.list_tickers and the linked Reference documentation, then reproduce the search="THC" example from the issue. Check whether the returned ordering comes from the API or the client, and consider the documented relevance ordering resolved only when the observed behavior and documentation agree.
Written by the indexing model from the issue text.
Description
Describe the bug
The documentation of the Python lib. states that if the "search" argument is given, list_tickers' results would be sorted by relevance:
https://polygon-api-client.readthedocs.io/en/latest/Reference.html#polygon.RESTClient.list_tickers
but it doesn't seem to be the case.
when using the example i included below, results are sorted by ticker.
To Reproduce
`from polygon import RESTClient
client = RESTClient("api-key")
tickers = []
for t in client.list_tickers(market="stocks", search="THC", limit=10,):
tickers.append(t)
print(tickers)
`
Expected behavior
I would have liked the results to be sorted by relevance to the search term.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 362
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from massive-com/client-python
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 72/100
massive-com/client-python#876 · 1 comment ·
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 72/100
massive-com/client-python#1031 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 45/100
massive-com/client-python#1029 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
massive-com/client-python#1028 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
massive-com/client-python#1022 ·
All issues in massive-com/client-python
Similar issues
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100