Skip to content

Commit 426d440

Browse files
author
Jirapongse Phuriphanvichai
authored
Update README.md
1 parent 89e0345 commit 426d440

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ serach(q, entityType='all', format="dataframe", start=1, num=5, order='rel')
131131
```
132132
|Parameter Name|Required|Description|
133133
|--------------|--------|-----------|
134-
|q|Yes|A query string to search for. It could be either just the search string value, or prefix it with "<fieldname>:" to constrain the search to a specific field, such as "**refinitiv**", "**ticker:IBM**", and "**ticker: msft AND exchange:NSM**". For a list of all avaialble fields, please refer to the [PermID User guide](https://developers.refinitiv.com/open-permid/permid-entity-search/docs?content=4885&type=documentation_item).|
134+
|q|Yes|A query string to search for. It could be either just the search string value, or prefix it with "<fieldname>:" to constrain the search to a specific field, such as "**refinitiv**", "**ticker:IBM**", and "**ticker: msft AND exchange:NSM**". For a list of all available fields, please refer to the [PermID User guide](https://developers.refinitiv.com/open-permid/permid-entity-search/docs?content=4885&type=documentation_item).|
135135
|entityType|No|The type of entity to search for. Possible values are **all**, **organization**, **instrument**, or **quote**. The default value is **all**|
136136
|format|No|The format of the output. Possible values are **dataframe**, **json**, or **xml**. The default value is **dataframe**|
137137
|start|No|The index of the first result returned, in the list of results ordered according to the order parameter. The index is 1-based. The default value is 1.|
@@ -162,7 +162,7 @@ The returned result is a data frame containing 10 entries of the **organization*
162162

163163
![Search for the entity type of "Refinitiv"](search2.png)
164164

165-
- **Call the search method to search for a "IBM" string with 'quote' and 'json' for the entityType and format parameters respectively**
165+
- **Call the search method to search for an "IBM" string with 'quote' and 'json' for the entityType and format parameters respectively**
166166
```
167167
output,err = opid.search('IBM',entityType='quote',format='json')
168168
```

0 commit comments

Comments
 (0)