Sending payload for GET request in python

Question

To filter the output, I can send a JSON to the API, like :

curl -X GET https://api.mysite.com/user \ 
  -H "Authorization: XXXXX" \ 
  -H "Content-Type: application/json"
  -d '{
    "q": {
      "name": {
          "eq": "0aslam0"
       }          
    }
  }'

The above works just fine. I am trying to send the same via python code using requests library.I tried the following code:

r = requests.get(url, headers=my_headers, params=payload)

where

url = "https://api.mysite.com/user"
my_headers = {
    'Authorization': 'XXXXX',
    'Content-Type': 'application/json',
    'Accept': 'application/json',
}
data = { 
    "q": {
        "name": {
            "eq": "0aslam0"
        }
    }
}
payload = json.dumps(data)

but r.text contains the output of a normal GET without applying filter. I logged the request, and saw that I was getting a redirect 301. I don't understand my mistake.

EDIT 1

I changed the code to :

r = requests.get(url, headers=my_headers, json=payload)

@Martijn was right. Using params was wrong. But the above also didn't succeed. I also added a header 'User-Agent': 'curl/7.40.0', to see if that could work. No luck there as well.

EDIT 2

The API documentation says, filtering can be done by another method. Changing the url into:

GET /user?q%5Bname%5D%5Beq%5D=0aslam0 HTTP/1.1

It is HTML encoded. So I tried, to format my url into such a format and avoid sending the payload, like:

r = requests.get(url, headers=my_headers)

And it works! So at least now I have a solution to my problem. But the question on how to send the payload (the method discussed above) for a GET request, still remains.

How is the Authorization header formed? Is there any signature included based on the request body perhaps? — Martijn Pieters
– Martijn Pieters, Commented Aug 9, 2016 at 11:05
Authorization header is a token generated for any developer of the API. No there is nothing such as a signature that is dependent on the request body. — 0aslam0
– 0aslam0, Commented Aug 9, 2016 at 11:13
Then I'm pretty much out of ideas; the answer below produces a request close to what your curl command does (which is rather strange in that it uses GET rather than POST). — Martijn Pieters
– Martijn Pieters, Commented Aug 9, 2016 at 12:23
@MartijnPieters Added some more details in the question. I don't think you were wrong. — 0aslam0
– 0aslam0, Commented Aug 9, 2016 at 12:49
The URL you see from curl means you have "q[name][eq]=0aslam0" as query parameters in the URL. curl will not set those from the command line you've shown here; it'd already be part of the URL or you used a --data-urlencode command-line option. — Martijn Pieters
– Martijn Pieters, Commented Aug 9, 2016 at 13:00

Martijn Pieters · Accepted Answer · 2016-08-09 10:00:05Z

5

When you use -d, the data is sent as a request body. params sends a URL query string, so that's the wrong argument to use.

Note that packaging along a request body with a GET method is technically a violation of the HTTP RFCs.

You'd have to send your request the data argument set instead, or pass in your dictionary to the json keyword argument and requests will encode that and set the right Content-Type header for you:

my_headers = {
    'Authorization': 'XXXXX',
}
data = { 
    "q": {
        "name": {
            "eq": "0aslam0"
        }
    }
}
r = requests.get(url, headers=my_headers, json=data)

edited Aug 9, 2016 at 10:00

answered Aug 9, 2016 at 9:49

Martijn Pieters

1.1m326 gold badges4.2k silver badges3.4k bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Martijn Pieters Over a year ago

@0aslam0: the same HTTP request is generated as what your curl command produces. The only difference is the User-Agent: curl/7.43.0 header, really.

Collectives™ on Stack Overflow

Sending payload for GET request in python

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related