vt-py icon indicating copy to clipboard operation
vt-py copied to clipboard

Documentation Improvement - iterator vs get_object

Open jaimeatwork opened this issue 1 year ago • 2 comments

Original Submission:

      client.get_object fails when attempting to pull resolutions. 
      
      example:
      ```
      resolutions = client.get_object("/ip_addresses/46.232.251.191/resolutions")
      ```
      
      This works through the API developers console, but not via the vt-py library.
      
      https://developers.virustotal.com/reference/ip-relationships
    
      Is there an improvement that can be made in handling these responses?

While submitting this issue, I realized I should have been using the iterator to iterate through the response instead of the using the get_object method. I read through the examples in the documentation and didn't see any references to when I might need to use the iterator vs when I could use single object calls.

I read through the quick start (https://virustotal.github.io/vt-py/quickstart.html) and the examples, but it wasn't clear that some endpoints don't support single get_object calls and need to be iterated. Instructions on when to use each of the different methods may be helpful, or maybe I missed something documented elsewhere. Thanks!

jaimeatwork avatar Sep 22 '22 14:09 jaimeatwork

Hello @jaimeatwork,

can you provide more detail about the issue?

Thanks!

Regards, Marta

mgmacias95 avatar Sep 22 '22 14:09 mgmacias95

Sorry about this, I was typing up the issue and accidentally submitted it before it was complete, I found I needed to use the iterator instead, I will complete the original submission shortly.

jaimeatwork avatar Sep 22 '22 14:09 jaimeatwork